Skip to content

Commit efcb241

Browse files
chrissmillerchrissmiller
authored
[Microsoft.DevCenter] Add 2023-09-01-preview dataplane version (#25335)
* Adds base for updating Microsoft.DevCenter from version preview/2023-07-01-preview to version 2023-09-01-preview * Updates readme * Updates API version in new specs and examples * Add displayname * Restore op location * Add suppression, remove extra comma * Add required prop suppression * Fix package tag * Remove directive
1 parent c8965b3 commit efcb241

Some content is hidden

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

43 files changed

+5339
-2
lines changed

‎specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json‎

Lines changed: 2370 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-09-01-preview/devcenter.json‎

Lines changed: 350 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,350 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2023-09-01-preview",
5+
"title": "DevCenter"
6+
},
7+
"x-ms-parameterized-host": {
8+
"hostTemplate": "{endpoint}",
9+
"useSchemePrefix": false,
10+
"parameters": [
11+
{
12+
"$ref": "devcenter.json#/parameters/EndpointParameter"
13+
}
14+
]
15+
},
16+
"schemes": [
17+
"https"
18+
],
19+
"consumes": [
20+
"application/json"
21+
],
22+
"produces": [
23+
"application/json"
24+
],
25+
"security": [
26+
{
27+
"AADToken": [
28+
"user_impersonation"
29+
]
30+
}
31+
],
32+
"securityDefinitions": {
33+
"AADToken": {
34+
"type": "oauth2",
35+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
36+
"flow": "implicit",
37+
"description": "Azure Active Directory OAuth2 Flow",
38+
"scopes": {
39+
"user_impersonation": "impersonate your user account"
40+
}
41+
}
42+
},
43+
"paths": {
44+
"/projects": {
45+
"get": {
46+
"tags": [
47+
"Projects"
48+
],
49+
"description": "Lists all projects.",
50+
"parameters": [
51+
{
52+
"$ref": "#/parameters/ApiVersionParameter"
53+
},
54+
{
55+
"$ref": "#/parameters/FilterParameter"
56+
},
57+
{
58+
"$ref": "#/parameters/TopParameter"
59+
}
60+
],
61+
"operationId": "DevCenter_ListProjects",
62+
"responses": {
63+
"200": {
64+
"description": "OK. The request has succeeded.",
65+
"schema": {
66+
"$ref": "#/definitions/ProjectListResult"
67+
}
68+
},
69+
"default": {
70+
"description": "Error response describing why the operation failed.",
71+
"schema": {
72+
"$ref": "#/definitions/CloudError"
73+
}
74+
}
75+
},
76+
"x-ms-examples": {
77+
"DevCenter_ListProjects": {
78+
"$ref": "./examples/Projects_ListByDevCenter.json"
79+
}
80+
},
81+
"x-ms-pageable": {
82+
"nextLinkName": "nextLink"
83+
}
84+
}
85+
},
86+
"/projects/{projectName}": {
87+
"get": {
88+
"tags": [
89+
"Projects"
90+
],
91+
"description": "Gets a project.",
92+
"parameters": [
93+
{
94+
"$ref": "#/parameters/ProjectNameMethodParameter"
95+
},
96+
{
97+
"$ref": "#/parameters/ApiVersionParameter"
98+
}
99+
],
100+
"operationId": "DevCenter_GetProject",
101+
"responses": {
102+
"200": {
103+
"description": "OK. The request has succeeded.",
104+
"schema": {
105+
"$ref": "#/definitions/Project"
106+
}
107+
},
108+
"default": {
109+
"description": "Error response describing why the operation failed.",
110+
"schema": {
111+
"$ref": "#/definitions/CloudError"
112+
}
113+
}
114+
},
115+
"x-ms-examples": {
116+
"DevCenter_GetProject": {
117+
"$ref": "./examples/Projects_Get.json"
118+
}
119+
}
120+
}
121+
}
122+
},
123+
"definitions": {
124+
"ProjectListResult": {
125+
"description": "Results of the project list operation.",
126+
"type": "object",
127+
"properties": {
128+
"value": {
129+
"description": "Current page of results.",
130+
"type": "array",
131+
"items": {
132+
"$ref": "#/definitions/Project"
133+
}
134+
},
135+
"nextLink": {
136+
"description": "URL to get the next set of results if there are any.",
137+
"type": "string"
138+
}
139+
},
140+
"required": [
141+
"value"
142+
]
143+
},
144+
"Project": {
145+
"description": "Project details.",
146+
"type": "object",
147+
"properties": {
148+
"uri": {
149+
"description": "The unique URI of the project",
150+
"type": "string"
151+
},
152+
"name": {
153+
"type": "string",
154+
"description": "Name of the project"
155+
},
156+
"description": {
157+
"type": "string",
158+
"description": "Description of the project."
159+
},
160+
"maxDevBoxesPerUser": {
161+
"type": "integer",
162+
"format": "int32",
163+
"minimum": 0,
164+
"description": "When specified, indicates the maximum number of Dev Boxes a single user can create across all pools in the project."
165+
},
166+
"displayName": {
167+
"type": "string",
168+
"description": "Display name of the project."
169+
}
170+
},
171+
"required": [
172+
"uri",
173+
"name"
174+
]
175+
},
176+
"CloudError": {
177+
"x-ms-external": true,
178+
"type": "object",
179+
"required": [
180+
"error"
181+
],
182+
"properties": {
183+
"error": {
184+
"description": "Error body",
185+
"$ref": "#/definitions/CloudErrorBody"
186+
}
187+
},
188+
"description": "An error response from the service."
189+
},
190+
"CloudErrorBody": {
191+
"x-ms-external": true,
192+
"description": "An error response from the service.",
193+
"type": "object",
194+
"required": [
195+
"code",
196+
"message"
197+
],
198+
"properties": {
199+
"code": {
200+
"type": "string",
201+
"description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
202+
},
203+
"message": {
204+
"type": "string",
205+
"description": "A message describing the error, intended to be suitable for display in a user interface."
206+
},
207+
"target": {
208+
"type": "string",
209+
"description": "The target of the particular error. For example, the name of the property in error."
210+
},
211+
"details": {
212+
"type": "array",
213+
"items": {
214+
"$ref": "#/definitions/CloudErrorBody"
215+
},
216+
"description": "A list of additional details about the error."
217+
}
218+
}
219+
},
220+
"OperationStatus": {
221+
"description": "The current status of an async operation",
222+
"type": "object",
223+
"properties": {
224+
"id": {
225+
"description": "Fully qualified ID for the operation status.",
226+
"type": "string"
227+
},
228+
"name": {
229+
"description": "The operation id name",
230+
"type": "string"
231+
},
232+
"status": {
233+
"description": "Provisioning state of the resource.",
234+
"type": "string"
235+
},
236+
"resourceId": {
237+
"description": "The id of the resource.",
238+
"type": "string"
239+
},
240+
"startTime": {
241+
"description": "The start time of the operation",
242+
"type": "string",
243+
"format": "date-time"
244+
},
245+
"endTime": {
246+
"description": "The end time of the operation",
247+
"type": "string",
248+
"format": "date-time"
249+
},
250+
"percentComplete": {
251+
"description": "Percent of the operation that is complete",
252+
"type": "number",
253+
"minimum": 0,
254+
"maximum": 100
255+
},
256+
"properties": {
257+
"description": "Custom operation properties, populated only for a successful operation.",
258+
"type": "object"
259+
},
260+
"error": {
261+
"description": "Operation Error message",
262+
"type": "object",
263+
"properties": {
264+
"code": {
265+
"type": "string",
266+
"description": "The error code."
267+
},
268+
"message": {
269+
"type": "string",
270+
"description": "The error message."
271+
}
272+
}
273+
}
274+
},
275+
"required": [
276+
"status"
277+
]
278+
}
279+
},
280+
"parameters": {
281+
"ProjectNameParameter": {
282+
"name": "projectName",
283+
"description": "The DevCenter Project upon which to execute operations.",
284+
"required": true,
285+
"type": "string",
286+
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$",
287+
"minLength": 3,
288+
"maxLength": 63,
289+
"in": "path",
290+
"x-ms-parameter-location": "client"
291+
},
292+
"ProjectNameMethodParameter": {
293+
"name": "projectName",
294+
"description": "The DevCenter Project upon which to execute operations.",
295+
"required": true,
296+
"type": "string",
297+
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$",
298+
"minLength": 3,
299+
"maxLength": 63,
300+
"in": "path",
301+
"x-ms-parameter-location": "method"
302+
},
303+
"ApiVersionParameter": {
304+
"name": "api-version",
305+
"in": "query",
306+
"required": true,
307+
"type": "string",
308+
"description": "The API version to be used with the HTTP request.",
309+
"x-ms-parameter-location": "client"
310+
},
311+
"FilterParameter": {
312+
"name": "filter",
313+
"in": "query",
314+
"description": "An OData filter clause to apply to the operation.",
315+
"type": "string",
316+
"required": false,
317+
"x-ms-parameter-location": "method"
318+
},
319+
"TopParameter": {
320+
"name": "top",
321+
"in": "query",
322+
"description": "The maximum number of resources to return from the operation. Example: 'top=10'.",
323+
"type": "integer",
324+
"format": "int32",
325+
"required": false,
326+
"x-ms-parameter-location": "method"
327+
},
328+
"UserIdParameter": {
329+
"name": "userId",
330+
"in": "path",
331+
"required": true,
332+
"x-ms-client-default": "me",
333+
"type": "string",
334+
"pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$",
335+
"minLength": 2,
336+
"maxLength": 36,
337+
"description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.",
338+
"x-ms-parameter-location": "method"
339+
},
340+
"EndpointParameter": {
341+
"name": "endpoint",
342+
"description": "The DevCenter-specific URI to operate on.",
343+
"required": true,
344+
"type": "string",
345+
"in": "path",
346+
"x-ms-skip-url-encoding": true,
347+
"x-ms-parameter-location": "client"
348+
}
349+
}
350+
}

0 commit comments

Comments
 (0)