Skip to content

Commit

Permalink
[Hub Generated] Publish private branch 'release-devcenter-Microsoft.D…
Browse files Browse the repository at this point in the history
…evCenter-2022-11-11-preview' (Azure#21454)

* Adds base for updating Microsoft.DevCenter from version preview/2022-03-01-preview to version 2022-11-11-preview

* Updates readme

* Updates API version in new specs and examples

* Add updated examples and spec

* Run prettier and resolve swagger checks

* Update client loc and format

* Restore URL format to satisfy HostParametersValidation

* Update host template naming

* Update to use "endpoint"

* Update formats and naming

* Remove artifacts

* Remove url formatting

* Expose hibernation support info

* Update naming based on feedback, restore hibernate query param

* Run prettier, fix ref

* Incorporate example changes

* Align param naming

* Align user ID naming

* Remove unnecessary LRO options

* Remove delete environment LRO options

* Fix reference that breaks swagger api view

* Add suppression

* Fix suppression format
  • Loading branch information
chrissmiller authored and anandanthony committed Dec 16, 2022
1 parent 87a4f85 commit 0c75ca9
Show file tree
Hide file tree
Showing 36 changed files with 4,070 additions and 3 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,301 @@
{
"swagger": "2.0",
"info": {
"version": "2022-11-11-preview",
"title": "DevCenter"
},
"x-ms-parameterized-host": {
"hostTemplate": "{endpoint}",
"useSchemePrefix": false,
"parameters": [
{
"$ref": "devcenter.json#/parameters/EndpointParameter"
}
]
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"AADToken": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"AADToken": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/projects": {
"get": {
"tags": [
"Projects"
],
"description": "Lists all projects.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/FilterParameter"
},
{
"$ref": "#/parameters/TopParameter"
}
],
"operationId": "DevCenter_ListProjects",
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ProjectListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"DevCenter_ListProjects": {
"$ref": "./examples/Projects_ListByDevCenter.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/projects/{projectName}": {
"get": {
"tags": [
"Projects"
],
"description": "Gets a project.",
"parameters": [
{
"$ref": "#/parameters/ProjectNameMethodParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"operationId": "DevCenter_GetProject",
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/Project"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"DevCenter_GetProject": {
"$ref": "./examples/Projects_Get.json"
}
}
}
}
},
"definitions": {
"ProjectListResult": {
"description": "Results of the project list operation.",
"type": "object",
"properties": {
"value": {
"description": "Current page of results.",
"type": "array",
"items": {
"$ref": "#/definitions/Project"
}
},
"nextLink": {
"description": "URL to get the next set of results if there are any.",
"type": "string"
}
},
"required": [
"value"
]
},
"Project": {
"description": "Project details.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the project",
"readOnly": true
},
"description": {
"type": "string",
"description": "Description of the project.",
"readOnly": true
}
}
},
"CloudError": {
"x-ms-external": true,
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"description": "Error body",
"$ref": "#/definitions/CloudErrorBody"
}
},
"description": "An error response from the service."
},
"CloudErrorBody": {
"x-ms-external": true,
"description": "An error response from the service.",
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
},
"message": {
"type": "string",
"description": "A message describing the error, intended to be suitable for display in a user interface."
},
"target": {
"type": "string",
"description": "The target of the particular error. For example, the name of the property in error."
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/CloudErrorBody"
},
"description": "A list of additional details about the error."
}
}
},
"ProvisioningError": {
"description": "Error details",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code."
},
"message": {
"type": "string",
"description": "The error message."
}
}
},
"EnableStatus": {
"description": "Enable or disable status. Indicates whether the property applied to is either enabled or disabled.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string",
"x-ms-enum": {
"name": "EnableStatus",
"modelAsString": true
}
}
},
"parameters": {
"ProjectNameParameter": {
"name": "projectName",
"description": "The DevCenter Project upon which to execute operations.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$",
"minLength": 3,
"maxLength": 63,
"in": "path",
"x-ms-parameter-location": "client"
},
"ProjectNameMethodParameter": {
"name": "projectName",
"description": "The DevCenter Project upon which to execute operations.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$",
"minLength": 3,
"maxLength": 63,
"in": "path",
"x-ms-parameter-location": "method"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "The API version to be used with the HTTP request.",
"x-ms-parameter-location": "client"
},
"FilterParameter": {
"name": "filter",
"in": "query",
"description": "An OData filter clause to apply to the operation.",
"type": "string",
"required": false,
"x-ms-parameter-location": "method"
},
"TopParameter": {
"name": "top",
"in": "query",
"description": "The maximum number of resources to return from the operation. Example: 'top=10'.",
"type": "integer",
"format": "int32",
"required": false,
"x-ms-parameter-location": "method"
},
"UserIdParameter": {
"name": "userId",
"in": "path",
"required": true,
"x-ms-client-default": "me",
"type": "string",
"pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$",
"minLength": 2,
"maxLength": 36,
"description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.",
"x-ms-parameter-location": "method"
},
"EndpointParameter": {
"name": "endpoint",
"description": "The DevCenter-specific URI to operate on.",
"required": true,
"type": "string",
"in": "path",
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "client"
}
}
}
Loading

0 comments on commit 0c75ca9

Please sign in to comment.