Skip to content

Commit f8dd177

Browse files
ygrikygrik
authored
Portal revision API (#11738)
* Portal revision API * fixed spec errors * fixed references * fixed return code on create and added long running operation properties * fixed create response * fixed comments * small fix
1 parent b75dcb4 commit f8dd177

File tree

9 files changed

+593
-0
lines changed

9 files changed

+593
-0
lines changed

‎specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimanagement.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,16 @@
547547
},
548548
"x-ms-parameter-location": "method"
549549
},
550+
"PortalRevisionIdParameter": {
551+
"name": "portalRevisionId",
552+
"in": "path",
553+
"required": true,
554+
"type": "string",
555+
"description": "Portal revision identifier. Must be unique in the current API Management service instance.",
556+
"minLength": 1,
557+
"maxLength": 256,
558+
"x-ms-parameter-location": "method"
559+
},
550560
"ProductIdParameter": {
551561
"name": "productId",
552562
"in": "path",

‎specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimportalrevisions.json‎

Lines changed: 326 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,326 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "ApiManagementClient",
5+
"description": "Use these REST APIs for performing operations in Azure API Management deployment.",
6+
"version": "2020-06-01-preview"
7+
},
8+
"host": "management.azure.com",
9+
"schemes": [
10+
"https"
11+
],
12+
"consumes": [
13+
"application/json"
14+
],
15+
"produces": [
16+
"application/json"
17+
],
18+
"security": [
19+
{
20+
"azure_auth": [
21+
"user_impersonation"
22+
]
23+
}
24+
],
25+
"securityDefinitions": {
26+
"azure_auth": {
27+
"type": "oauth2",
28+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
29+
"flow": "implicit",
30+
"description": "Azure Active Directory OAuth2 Flow.",
31+
"scopes": {
32+
"user_impersonation": "impersonate your user account"
33+
}
34+
}
35+
},
36+
"paths": {
37+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions": {
38+
"get": {
39+
"tags": [
40+
"PortalRevision"
41+
],
42+
"operationId": "PortalRevision_ListByService",
43+
"description": "Lists a collection of developer portal revision entities.",
44+
"x-ms-examples": {
45+
"ApiManagementListPortalRevisions": {
46+
"$ref": "./examples/ApiManagementListPortalRevisions.json"
47+
}
48+
},
49+
"parameters": [
50+
{
51+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
52+
},
53+
{
54+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
55+
},
56+
{
57+
"name": "$filter",
58+
"in": "query",
59+
"required": false,
60+
"type": "string",
61+
"description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|-----------------------------------|\n\r\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|isCurrent | eq, ne | |\n"
62+
},
63+
{
64+
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
65+
},
66+
{
67+
"$ref": "./apimanagement.json#/parameters/SkipQueryParameter"
68+
},
69+
{
70+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
71+
},
72+
{
73+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
74+
}
75+
],
76+
"responses": {
77+
"200": {
78+
"description": "Lists a collection of developer portal revision entities.",
79+
"schema": {
80+
"$ref": "./definitions.json#/definitions/PortalRevisionCollection"
81+
}
82+
},
83+
"default": {
84+
"description": "Error response describing why the operation failed.",
85+
"schema": {
86+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
87+
}
88+
}
89+
},
90+
"x-ms-pageable": {
91+
"nextLinkName": "nextLink"
92+
}
93+
}
94+
},
95+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalRevisions/{portalRevisionId}": {
96+
"head": {
97+
"tags": [
98+
"PortalRevision"
99+
],
100+
"operationId": "PortalRevision_GetEntityTag",
101+
"description": "Gets developer portal revision specified by its identifier.",
102+
"x-ms-examples": {
103+
"ApiManagementHeadPortalRevision": {
104+
"$ref": "./examples/ApiManagementHeadPortalRevision.json"
105+
}
106+
},
107+
"parameters": [
108+
{
109+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
110+
},
111+
{
112+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
113+
},
114+
{
115+
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
116+
},
117+
{
118+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
119+
},
120+
{
121+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
122+
}
123+
],
124+
"responses": {
125+
"200": {
126+
"description": "Specified Portal revision entity exists and current entity state version is present in the ETag header.",
127+
"headers": {
128+
"ETag": {
129+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
130+
"type": "string"
131+
}
132+
}
133+
},
134+
"default": {
135+
"description": "Error response describing why the operation failed.",
136+
"schema": {
137+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
138+
}
139+
}
140+
}
141+
},
142+
"get": {
143+
"tags": [
144+
"PortalRevision"
145+
],
146+
"operationId": "PortalRevision_Get",
147+
"description": "Gets developer portal revision specified by its identifier.",
148+
"x-ms-examples": {
149+
"ApiManagementGetPortalRevision": {
150+
"$ref": "./examples/ApiManagementGetPortalRevision.json"
151+
}
152+
},
153+
"parameters": [
154+
{
155+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
156+
},
157+
{
158+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
159+
},
160+
{
161+
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
162+
},
163+
{
164+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
165+
},
166+
{
167+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
168+
}
169+
],
170+
"responses": {
171+
"200": {
172+
"description": "Gets the specified developer portal revision entity.",
173+
"schema": {
174+
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
175+
},
176+
"headers": {
177+
"ETag": {
178+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
179+
"type": "string"
180+
}
181+
}
182+
},
183+
"default": {
184+
"description": "Error response describing why the operation failed.",
185+
"schema": {
186+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
187+
}
188+
}
189+
}
190+
},
191+
"put": {
192+
"tags": [
193+
"PortalRevision"
194+
],
195+
"operationId": "PortalRevision_CreateOrUpdate",
196+
"description": "Creates a new developer portal revision.",
197+
"x-ms-examples": {
198+
"ApiManagementCreatePortalRevision": {
199+
"$ref": "./examples/ApiManagementCreatePortalRevision.json"
200+
}
201+
},
202+
"parameters": [
203+
{
204+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
205+
},
206+
{
207+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
208+
},
209+
{
210+
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
211+
},
212+
{
213+
"name": "parameters",
214+
"in": "body",
215+
"required": true,
216+
"schema": {
217+
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
218+
}
219+
},
220+
{
221+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
222+
},
223+
{
224+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
225+
}
226+
],
227+
"responses": {
228+
"202": {
229+
"description": "Request to create developer portal revision was accepted."
230+
},
231+
"201": {
232+
"description": "Developer portal revision was successfully created.",
233+
"schema": {
234+
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
235+
},
236+
"headers": {
237+
"ETag": {
238+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
239+
"type": "string"
240+
}
241+
}
242+
},
243+
"default": {
244+
"description": "Error response describing why the operation failed.",
245+
"schema": {
246+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
247+
}
248+
}
249+
},
250+
"x-ms-long-running-operation": true,
251+
"x-ms-long-running-operation-options": {
252+
"final-state-via": "location"
253+
}
254+
},
255+
"patch": {
256+
"tags": [
257+
"PortalRevision"
258+
],
259+
"operationId": "PortalRevision_Update",
260+
"description": "Updates the description of specified portal revision or makes it current.",
261+
"x-ms-examples": {
262+
"ApiManagementUpdatePortalRevision": {
263+
"$ref": "./examples/ApiManagementUpdatePortalRevision.json"
264+
}
265+
},
266+
"parameters": [
267+
{
268+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
269+
},
270+
{
271+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
272+
},
273+
{
274+
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
275+
},
276+
{
277+
"name": "parameters",
278+
"in": "body",
279+
"required": true,
280+
"schema": {
281+
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
282+
}
283+
},
284+
{
285+
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
286+
},
287+
{
288+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
289+
},
290+
{
291+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
292+
}
293+
],
294+
"responses": {
295+
"202": {
296+
"description": "Request to update developer portal revision was accepted."
297+
},
298+
"200": {
299+
"description": "Developer portal revision was successfully updated.",
300+
"schema": {
301+
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
302+
},
303+
"headers": {
304+
"ETag": {
305+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
306+
"type": "string"
307+
}
308+
}
309+
},
310+
"default": {
311+
"description": "Error response describing why the operation failed.",
312+
"schema": {
313+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
314+
}
315+
}
316+
},
317+
"x-ms-long-running-operation": true,
318+
"x-ms-long-running-operation-options": {
319+
"final-state-via": "location"
320+
}
321+
}
322+
}
323+
},
324+
"definitions": {},
325+
"parameters": {}
326+
}

0 commit comments

Comments
 (0)