Skip to content

Commit 237ffab

Browse files
shinjiDevsolankisamirazaslonovDreamlessAyingru97
authored and
Leiwang3SQL
committed
Schema resource added in REST API Spec for api-version 2021-08-01 (Azure#16715)
* Adds base for updating Microsoft.ApiManagement from version preview/2021-01-01-preview to version 2021-04-01-preview * Updates readme * Updates API version in new specs and examples * Added support for GraphQL API type (Azure#14851) * Added support for GraphQL API type * Added missing enum value for GraphQL APIs. * add schema definition fix from 2021-01-01-preview (Azure#14883) Co-authored-by: Alan Feng <alanfeng@microsoft.com> * Vanguard: Get Outbound Network Dependency (Azure#14900) * outbound dependency * fix resource * Update backup/restore API for managed identities (Azure#14973) * Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id * SystemData implemenation on API Management Control Plane (Azure#14899) * system-data * fix spec * remove unreferenced file * APIM - Network Watcher Connectivity Check integration specs (Azure#15056) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Parameter examples added (Azure#14836) * platformversion (Azure#15114) * fix update service (Azure#15478) * HttpConnect example (Azure#15493) * HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Rename from SchemaContract to ApiSchemaContract * apimschema.json added to last apim preview version * Completing specification for Schema resource. Fixing changes in SchemaContract. * Value field added to Schema resource specification. * path fixed. Renamed from ApiSchema to Schema. Adding suppression rule to readme.md Custom word added for spellcheck * Fixing PR observations. * Added properties of difference API spec format for "SchemaDocumentProperties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix * [APIM]Add private endpoint connection APIs (Azure#15115) * Add private endpoint connection apis * add readme * quick fixes * fix to PE contract * Small fixes * small fixes * small fixes * Small fixes * small fixes * small fix * small fixes * small fixes * small fixes * Update readme.md * fix error * small fix * fix format * address comments * small fixes * Change to lower case * small fixes Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> * Adds base for updating Microsoft.ApiManagement from version preview/2021-04-01-preview to version 2021-08-01 * Updates readme * Updates API version in new specs and examples * Merge main * Modifications to Schema definition to add "description" field. Updating examples of Schema. * Fixing apimanagement.json * Prettier applied in files * Fixing PR comments * fixing x-ms-long-running-operation. * x-ms-long-running-operation : true in apischema. * Removing "Resource" type from apimanagement.json * Apimschema.json updated to point to types.json for ErrorResponse. * Merging from 2021-04-01-preview to 2021-08-01 stable version. * undoing change of responseBody * Updating ErrorResponse. * Fixing definitions merge. * Changing definitions to fix output of examples. * Changes in definitions * Updating response in some examples. * Rolling back ApiSchema -> Schema Schema -> GlobalSchema * Changes to undo apimapis.json and adding prefix for Global example Schemas. * Setting x-ms-long-running-operation-options to location. Co-authored-by: Samir Solanki <samirsolanki@outlook.com> Co-authored-by: Alexander Zaslonov <zaslonov.alexander@gmail.com> Co-authored-by: DreamlessA <DreamlessA@users.noreply.github.com> Co-authored-by: Alan Feng <alanfeng@microsoft.com> Co-authored-by: Jatin Sanghvi <20547963+JatinSanghvi@users.noreply.github.com> Co-authored-by: Nicolás Barrera <nicolasbarrera@outlook.com> Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> Co-authored-by: VitaliyKurokhtin <vitaliik@microsoft.com> Co-authored-by: Christian Palomares <cpalomar@microsoft.com> Co-authored-by: RupengLiu <rliu1211@terpmail.umd.edu> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
1 parent 82f3897 commit 237ffab

File tree

11 files changed

+743
-17
lines changed

11 files changed

+743
-17
lines changed

‎specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -607,17 +607,6 @@
607607
"description": "The name of the resource group.",
608608
"x-ms-parameter-location": "method"
609609
},
610-
"SchemaIdParameter": {
611-
"name": "schemaId",
612-
"in": "path",
613-
"required": true,
614-
"type": "string",
615-
"description": "Schema identifier within an API. Must be unique in the current API Management service instance.",
616-
"minLength": 1,
617-
"maxLength": 80,
618-
"pattern": "^[^*#&+:<>?]+$",
619-
"x-ms-parameter-location": "method"
620-
},
621610
"ServiceNameParameter": {
622611
"name": "serviceName",
623612
"in": "path",
@@ -765,6 +754,16 @@
765754
"minLength": 1,
766755
"maxLength": 80,
767756
"x-ms-parameter-location": "method"
757+
},
758+
"SchemaIdParameter": {
759+
"name": "schemaId",
760+
"in": "path",
761+
"required": true,
762+
"type": "string",
763+
"description": "Schema id identifier. Must be unique in the current API Management service instance.",
764+
"minLength": 1,
765+
"maxLength": 80,
766+
"x-ms-parameter-location": "method"
768767
}
769768
}
770769
}

‎specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/apimschema.json‎

Lines changed: 331 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,331 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "ApiManagementClient",
5+
"description": "Use these REST APIs for performing operations on Schema entity in Azure API Management deployment.",
6+
"version": "2021-08-01"
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}/schemas": {
38+
"get": {
39+
"tags": [
40+
"Schema"
41+
],
42+
"operationId": "GlobalSchema_ListByService",
43+
"description": "Lists a collection of schemas registered with service instance.",
44+
"x-ms-examples": {
45+
"ApiManagementListSchemas": {
46+
"$ref": "./examples/ApiManagementListGlobalSchemas.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 | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>"
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 Schema entities.",
79+
"schema": {
80+
"$ref": "./definitions.json#/definitions/GlobalSchemaCollection"
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+
"x-ms-odata": "./definitions.json#/definitions/GlobalSchemaContract"
94+
}
95+
},
96+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas/{schemaId}": {
97+
"head": {
98+
"tags": [
99+
"Schema"
100+
],
101+
"operationId": "GlobalSchema_GetEntityTag",
102+
"description": "Gets the entity state (Etag) version of the Schema specified by its identifier.",
103+
"x-ms-examples": {
104+
"ApiManagementHeadApi": {
105+
"$ref": "./examples/ApiManagementHeadGlobalSchema.json"
106+
}
107+
},
108+
"parameters": [
109+
{
110+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
111+
},
112+
{
113+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
114+
},
115+
{
116+
"$ref": "./apimanagement.json#/parameters/SchemaIdParameter"
117+
},
118+
{
119+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
120+
},
121+
{
122+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
123+
}
124+
],
125+
"responses": {
126+
"200": {
127+
"description": "Specified Schema entity exists and current entity state version is present in the ETag header.",
128+
"headers": {
129+
"ETag": {
130+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
131+
"type": "string"
132+
}
133+
}
134+
},
135+
"default": {
136+
"description": "Error response describing why the operation failed.",
137+
"schema": {
138+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
139+
}
140+
}
141+
}
142+
},
143+
"get": {
144+
"tags": [
145+
"Schema"
146+
],
147+
"operationId": "GlobalSchema_Get",
148+
"description": "Gets the details of the Schema specified by its identifier.",
149+
"x-ms-examples": {
150+
"ApiManagementGetSchema1": {
151+
"$ref": "./examples/ApiManagementGetGlobalSchema1.json"
152+
},
153+
"ApiManagementGetSchema2": {
154+
"$ref": "./examples/ApiManagementGetGlobalSchema2.json"
155+
}
156+
},
157+
"produces": [
158+
"application/json"
159+
],
160+
"parameters": [
161+
{
162+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
163+
},
164+
{
165+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
166+
},
167+
{
168+
"$ref": "./apimanagement.json#/parameters/SchemaIdParameter"
169+
},
170+
{
171+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
172+
},
173+
{
174+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
175+
}
176+
],
177+
"responses": {
178+
"200": {
179+
"description": "The response body contains the specified Schema entity.",
180+
"schema": {
181+
"$ref": "./definitions.json#/definitions/GlobalSchemaContract"
182+
},
183+
"headers": {
184+
"ETag": {
185+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
186+
"type": "string"
187+
}
188+
}
189+
},
190+
"default": {
191+
"description": "Error response describing why the operation failed.",
192+
"schema": {
193+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
194+
}
195+
}
196+
}
197+
},
198+
"put": {
199+
"tags": [
200+
"Schema"
201+
],
202+
"operationId": "GlobalSchema_CreateOrUpdate",
203+
"description": "Creates new or updates existing specified Schema of the API Management service instance.",
204+
"x-ms-examples": {
205+
"ApiManagementCreateSchema1": {
206+
"$ref": "./examples/ApiManagementCreateGlobalSchema1.json"
207+
},
208+
"ApiManagementCreateSchema2": {
209+
"$ref": "./examples/ApiManagementCreateGlobalSchema2.json"
210+
}
211+
},
212+
"parameters": [
213+
{
214+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
215+
},
216+
{
217+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
218+
},
219+
{
220+
"$ref": "./apimanagement.json#/parameters/SchemaIdParameter"
221+
},
222+
{
223+
"name": "parameters",
224+
"in": "body",
225+
"required": true,
226+
"schema": {
227+
"$ref": "./definitions.json#/definitions/GlobalSchemaContract"
228+
},
229+
"description": "Create or update parameters."
230+
},
231+
{
232+
"$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter"
233+
},
234+
{
235+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
236+
},
237+
{
238+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
239+
}
240+
],
241+
"responses": {
242+
"201": {
243+
"description": "The new Schema was successfully added.",
244+
"headers": {
245+
"ETag": {
246+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
247+
"type": "string"
248+
}
249+
},
250+
"schema": {
251+
"$ref": "./definitions.json#/definitions/GlobalSchemaContract"
252+
}
253+
},
254+
"200": {
255+
"description": "The Schema details were successfully updated.",
256+
"headers": {
257+
"ETag": {
258+
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
259+
"type": "string"
260+
}
261+
},
262+
"schema": {
263+
"$ref": "./definitions.json#/definitions/GlobalSchemaContract"
264+
}
265+
},
266+
"202": {
267+
"description": "Accepted the change when updating the service."
268+
},
269+
"default": {
270+
"description": "Error response describing why the operation failed.",
271+
"schema": {
272+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
273+
}
274+
}
275+
},
276+
"x-ms-long-running-operation": true,
277+
"x-ms-long-running-operation-options": {
278+
"final-state-via": "location"
279+
}
280+
},
281+
"delete": {
282+
"tags": [
283+
"Schema"
284+
],
285+
"operationId": "GlobalSchema_Delete",
286+
"description": "Deletes specific Schema.",
287+
"x-ms-examples": {
288+
"ApiManagementDeleteSchema": {
289+
"$ref": "./examples/ApiManagementDeleteGlobalSchema.json"
290+
}
291+
},
292+
"parameters": [
293+
{
294+
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
295+
},
296+
{
297+
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
298+
},
299+
{
300+
"$ref": "./apimanagement.json#/parameters/SchemaIdParameter"
301+
},
302+
{
303+
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
304+
},
305+
{
306+
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
307+
},
308+
{
309+
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
310+
}
311+
],
312+
"responses": {
313+
"200": {
314+
"description": "The Schema was successfully deleted."
315+
},
316+
"204": {
317+
"description": "The Schema was successfully deleted."
318+
},
319+
"default": {
320+
"description": "Error response describing why the operation failed.",
321+
"schema": {
322+
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
323+
}
324+
}
325+
}
326+
}
327+
}
328+
},
329+
"definitions": {},
330+
"parameters": {}
331+
}

0 commit comments

Comments
 (0)