Skip to content

Commit 9eb2f47

Browse files
added example strings to endpoints
1 parent 3d68ace commit 9eb2f47

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

openapi.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,10 @@ paths:
4040
- name: code
4141
in: query
4242
required: true
43+
description: SIC Code (e.g. 0111)
4344
schema:
4445
type: string
45-
description: SIC Code (e.g. 0111)
46+
example: "0111"
4647
responses:
4748
"200":
4849
description: JSON object mapping SIC Code to Description
@@ -99,9 +100,10 @@ paths:
99100
- name: descrip
100101
in: query
101102
required: true
103+
description: Search keyword (case-insensitive) e.g. "fishing"
102104
schema:
103105
type: string
104-
description: Search keyword (case-insensitive) e.g. "fishing"
106+
example: "fishing"
105107
responses:
106108
"200":
107109
description: JSON object mapping SIC Codes to Descriptions

0 commit comments

Comments
 (0)