-
Notifications
You must be signed in to change notification settings - Fork 2
/
OAS_example.yaml
172 lines (172 loc) · 3.55 KB
/
OAS_example.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
swagger: "2.0"
info:
description: "This is a sample server"
version: "1.0.0"
title: "Swagger Example"
host: "localhost:8080"
basePath: "/api"
schemes:
- "http"
paths:
/optionalParams:
get:
summary: "Operation with optional parameters only"
description: "Operation with optional parameters only"
operationId: "optionalParams"
produces:
- "application/json"
parameters:
- name: "p1"
in: "query"
description: "p1"
required: false
type: "string"
- name: "p2"
in: "query"
description: "p2"
required: false
type: "string"
- name: "p3"
in: "query"
description: "p3"
required: false
type: "string"
enum:
- "test1"
- "test2"
- name: "p4"
in: "query"
description: "p4"
required: false
type: "string"
enum:
- "mi gente"
- "mis gentes"
x-dependencies:
- IF p1 THEN p2;
- IF p3 THEN NOT p4;
responses:
200:
description: "OK"
400:
description: "Bad Request"
/requiredParams:
get:
summary: "Operation with required parameters only"
description: "Operation with required parameters only"
operationId: "requiredParams"
produces:
- "application/json"
parameters:
- name: "p1"
in: "query"
description: "p1"
required: true
type: "integer"
enum:
- 1
- 2
- name: "p2"
in: "query"
description: "p2"
required: true
type: "integer"
enum:
- 1
- 2
- 3
- name: "p3"
in: "query"
description: "p3"
required: true
type: "integer"
enum:
- 1
- 2
- 3
- 4
- name: "p4"
in: "query"
description: "p4"
required: true
type: "integer"
enum:
- 1
- 2
- 3
- 4
- 5
responses:
200:
description: "OK"
400:
description: "Bad Request"
/requiredAndOptionalParams:
get:
summary: "Operation with required and optional parameters"
description: "Operation with required and optional parameters"
operationId: "requiredAndOptionalParams"
produces:
- "application/json"
parameters:
- name: "p1"
in: "query"
description: "p1"
required: true
type: "integer"
enum:
- 1
- 2
- name: "p2"
in: "query"
description: "p2"
required: true
type: "integer"
enum:
- 1
- 2
- 3
- name: "p3"
in: "query"
description: "p3"
required: false
type: "integer"
enum:
- 1
- 2
- 3
- 4
- name: "p4"
in: "query"
description: "p4"
required: false
type: "integer"
enum:
- 1
- 2
- 3
- 4
- 5
- name: "type"
in: "query"
description: "p4"
required: false
type: "string"
enum:
- "value1"
- "value2"
- "value3"
- name: "Accept-Language"
in: "query"
description: "p4"
required: false
type: "string"
enum:
- "fghdfgh"
- "drtfyhdtryh"
- "rhdrhdrtyh"
responses:
200:
description: "OK"
400:
description: "Bad Request"