Skip to content

Commit 0f7c0d5

Browse files
sarettesarette
authored
Merge pull request #1046 from sarette/DOCS-8821-API-Specs
Made changes to SD-WAN Spec files.
2 parents e18419e + dc02628 commit 0f7c0d5

77 files changed

Lines changed: 79491 additions & 141107 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎openapi-specs/sdwan/legacy/ADEM.yaml‎

Lines changed: 66 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -2,133 +2,84 @@ components:
22
schemas:
33
DemStatus:
44
properties:
5-
dem_enabled:
6-
description: "Indicates whether ADEM is enabled for your instance. \
7-
\ \n"
8-
type: boolean
9-
id:
10-
description: 'ID of the ADEM instances.
5+
dem_enabled: {description: "Indicates whether ADEM is enabled for your instance.\
6+
\ \n", type: boolean}
7+
id: {description: 'ID of the ADEM instances.
118

12-
'
13-
type: string
14-
site_id:
15-
description: 'ID of the remote site.
9+
', type: string}
10+
site_id: {description: 'ID of the remote site.
1611

17-
'
18-
type: string
19-
tenant_id:
20-
description: "The tenant ID. \n"
21-
type: string
22-
required:
23-
- site_id
24-
- tenant_id
12+
', type: string}
13+
tenant_id: {description: "The tenant ID. \n", type: string}
14+
required: [site_id, tenant_id]
2515
DemStatusQueryResponse:
2616
properties:
27-
dem_enabled:
28-
description: 'Indicates whether ADEM is enabled for your instance.
17+
dem_enabled: {description: 'Indicates whether ADEM is enabled for your instance.
2918

30-
'
31-
type: boolean
32-
id:
33-
description: 'ID of the DEM status.
19+
', type: boolean}
20+
id: {description: 'ID of the DEM status.
3421

35-
'
36-
type: string
37-
site_id:
38-
description: 'ID of the remote site. More details on the site can be retrieved
39-
by querying the sites API.
22+
', type: string}
23+
site_id: {description: 'ID of the remote site. More details on the site can
24+
be retrieved by querying the sites API.
4025

41-
'
42-
type: string
43-
tenant_id:
44-
description: "The tenant ID. \n"
45-
type: string
46-
required:
47-
- site_id
48-
- tenant_id
26+
', type: string}
27+
tenant_id: {description: "The tenant ID. \n", type: string}
28+
required: [site_id, tenant_id]
4929
Error:
5030
properties:
5131
_error:
52-
items:
53-
$ref: '#/components/schemas/ErrorResponse'
32+
items: {$ref: '#/components/schemas/ErrorResponse'}
5433
type: array
5534
ErrorResponse:
5635
properties:
57-
code:
58-
description: 'The error code.
36+
code: {description: 'The error code.
5937

60-
'
61-
type: string
62-
message:
63-
description: 'The error message.
38+
', type: string}
39+
message: {description: 'The error message.
6440

65-
'
66-
type: string
41+
', type: string}
6742
ListQueryResponse:
6843
properties:
69-
count:
70-
description: 'The actual count.
44+
count: {description: 'The actual count.
7145

72-
'
73-
format: int32
74-
type: integer
75-
deleted_count:
76-
description: 'The deleted number.
46+
', format: int32, type: integer}
47+
deleted_count: {description: 'The deleted number.
7748

78-
'
79-
format: int64
80-
type: integer
49+
', format: int64, type: integer}
8150
deleted_ids:
8251
description: 'The deleted IDs.
8352

8453
'
85-
items:
86-
type: string
54+
items: {type: string}
8755
type: array
88-
description:
89-
description: 'Description of the query. Max size = 256.
56+
description: {description: 'Description of the query. Max size = 256.
9057

91-
'
92-
id:
93-
description: 'The ID.
58+
'}
59+
id: {description: 'The ID.
9460

95-
'
96-
type: string
97-
next_query:
98-
description: 'Details of the next query.
61+
', type: string}
62+
next_query: {description: 'Details of the next query.
9963

100-
'
101-
type: object
102-
tenant_id:
103-
description: 'The tenant ID.
64+
', type: object}
65+
tenant_id: {description: 'The tenant ID.
10466

105-
'
106-
type: string
107-
total_count:
108-
description: 'Total number.
67+
', type: string}
68+
total_count: {description: 'Total number.
10969

110-
'
111-
format: int64
112-
type: integer
70+
', format: int64, type: integer}
11371
type: object
11472
ListResponse:
11573
properties:
116-
count:
117-
description: 'The actual count.
74+
count: {description: 'The actual count.
11875

119-
'
120-
format: int32
121-
type: integer
122-
id:
123-
description: 'The ID.
76+
', format: int32, type: integer}
77+
id: {description: 'The ID.
12478

125-
'
126-
type: string
127-
tenant_id:
128-
description: 'The tenant ID.
79+
', type: string}
80+
tenant_id: {description: 'The tenant ID.
12981

130-
'
131-
type: string
82+
', type: string}
13283
type: object
13384
info:
13485
contact: {}
@@ -146,31 +97,26 @@ paths:
14697
in: path
14798
name: tenant_id
14899
required: true
149-
schema:
150-
description: Tenant Id
151-
type: string
100+
schema: {description: Tenant Id, type: string}
152101
requestBody:
153102
content:
154103
application/json:
155-
schema:
156-
$ref: '#/components/schemas/DemStatusQueryResponse'
104+
schema: {$ref: '#/components/schemas/DemStatusQueryResponse'}
157105
responses:
158106
'200':
159107
content:
160108
application/json:
161109
schema:
162110
allOf:
163-
- $ref: '#/components/schemas/ListQueryResponse'
111+
- {$ref: '#/components/schemas/ListQueryResponse'}
164112
- properties:
165113
items:
166-
items:
167-
$ref: '#/components/schemas/DemStatusQueryResponse'
114+
items: {$ref: '#/components/schemas/DemStatusQueryResponse'}
168115
type: array
169116
type: object
170117
description: Successful operation
171118
summary: Query ADEM Status
172-
tags:
173-
- ADEM
119+
tags: [ADEM]
174120
/v2.0/api/tenants/{tenant_id}/sites/{site_id}/demstatus:
175121
get:
176122
description: Get all ADEM statuses for all sites.
@@ -180,27 +126,22 @@ paths:
180126
in: path
181127
name: tenant_id
182128
required: true
183-
schema:
184-
description: Tenant Id
185-
type: string
129+
schema: {description: Tenant Id, type: string}
186130
- description: The ADEM enabled site IDs.
187131
in: path
188132
name: site_id
189133
required: true
190-
schema:
191-
description: Site Id
192-
type: string
134+
schema: {description: Site Id, type: string}
193135
responses:
194136
'200':
195137
content:
196138
application/json:
197139
schema:
198140
allOf:
199-
- $ref: '#/components/schemas/ListResponse'
141+
- {$ref: '#/components/schemas/ListResponse'}
200142
- properties:
201143
items:
202-
items:
203-
$ref: '#/components/schemas/DemStatus'
144+
items: {$ref: '#/components/schemas/DemStatus'}
204145
type: array
205146
type: object
206147
description: Successful operation
@@ -210,13 +151,11 @@ paths:
210151
example:
211152
value:
212153
_error:
213-
- code: SITE_NOT_FOUND
214-
schema:
215-
$ref: '#/components/schemas/Error'
154+
- {code: SITE_NOT_FOUND}
155+
schema: {$ref: '#/components/schemas/Error'}
216156
description: Bad Request
217157
summary: Get ADEM Status (v2.0)
218-
tags:
219-
- ADEM
158+
tags: [ADEM]
220159
/v2.0/api/tenants/{tenant_id}/sites/{site_id}/demstatus/{dem_status_id}:
221160
get:
222161
description: Get DEM status for a site in Prisma SD-WAN.
@@ -226,54 +165,44 @@ paths:
226165
in: path
227166
name: tenant_id
228167
required: true
229-
schema:
230-
description: Tenant Id
231-
type: string
168+
schema: {description: Tenant Id, type: string}
232169
- description: The ADEM enabled site IDs.
233170
in: path
234171
name: site_id
235172
required: true
236-
schema:
237-
description: Site Id
238-
type: string
173+
schema: {description: Site Id, type: string}
239174
- description: The status ID of the ADEM enabled site.
240175
in: path
241176
name: dem_status_id
242177
required: true
243-
schema:
244-
description: Dem Status Id
245-
type: string
178+
schema: {description: Dem Status Id, type: string}
246179
responses:
247180
'200':
248181
content:
249182
application/json:
250-
schema:
251-
$ref: '#/components/schemas/DemStatus'
183+
schema: {$ref: '#/components/schemas/DemStatus'}
252184
description: Successful operation
253185
'400':
254186
content:
255187
application/json:
256188
example:
257189
value:
258190
_error:
259-
- code: SITE_NOT_FOUND
260-
schema:
261-
$ref: '#/components/schemas/Error'
191+
- {code: SITE_NOT_FOUND}
192+
schema: {$ref: '#/components/schemas/Error'}
262193
description: Bad Request
263194
'404':
264195
content:
265196
application/json:
266197
example:
267198
value:
268199
_error:
269-
- code: SITE_NOT_FOUND
270-
schema:
271-
$ref: '#/components/schemas/Error'
200+
- {code: SITE_NOT_FOUND}
201+
schema: {$ref: '#/components/schemas/Error'}
272202
description: Bad Request
273203
summary: Get ADEM Status for Site (v2.0)
274-
tags:
275-
- ADEM
204+
tags: [ADEM]
276205
servers:
277-
- url: https://api.us.cloudgenix.com
206+
- {url: 'https://api.us.cloudgenix.com'}
278207
tags:
279-
- name: ADEM
208+
- {name: ADEM}

0 commit comments

Comments
 (0)