Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Hub Generated] Review request for Microsoft.DevCenter to add version preview/2023-07-01-preview #24291

Merged
merged 23 commits into from
Jul 10, 2023
Merged

[Hub Generated] Review request for Microsoft.DevCenter to add version preview/2023-07-01-preview #24291

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
bd1080b
Adds base for updating Microsoft.DevCenter from version preview/2023-…
chrissmiller May 22, 2023
d71c9f7
Updates readme
chrissmiller May 22, 2023
e625958
Updates API version in new specs and examples
chrissmiller May 22, 2023
309bc2f
Add schedule and troubleshoot APIs, add generic id property, update e…
chrissmiller Jun 5, 2023
d78211e
Add troubleshoot example and update environment examples
chrissmiller Jun 5, 2023
8292390
Add ID to project
chrissmiller Jun 5, 2023
742db3e
Add environment operations API
chrissmiller Jun 5, 2023
8fe0c8a
Re-add last operation ID
chrissmiller Jun 5, 2023
7f196db
Run prettier
chrissmiller Jun 5, 2023
a862abe
Add ID to delay result
chrissmiller Jun 5, 2023
cff68ae
Add suppression for host parameters validation
chrissmiller Jun 5, 2023
5b6f0db
Remove last operation ID
chrissmiller Jun 12, 2023
b10c41a
Update with aligned operations API, URI property, file type log response
chrissmiller Jun 20, 2023
e001f36
Remove old examples
chrissmiller Jun 20, 2023
c41019c
Fix naming
chrissmiller Jun 20, 2023
eb9ee7e
Update TTL to 90 days on operations, add delete operationkind
chrissmiller Jun 20, 2023
d5aca43
Add sourceType
chrissmiller Jun 20, 2023
5820bdc
Remove old model
chrissmiller Jun 20, 2023
10c8727
Use an enum for status
chrissmiller Jun 20, 2023
30f653b
Consolidate on "sourceUri" for consistency with "uri" property
chrissmiller Jun 22, 2023
0d96762
Description updates
chrissmiller Jun 23, 2023
4dbaf49
Add NotStarted state
chrissmiller Jun 26, 2023
d301413
Add default response and missing LRO options to resolve LintDiff warn…
chrissmiller Jun 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
389 changes: 325 additions & 64 deletions ...ification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions ...cation/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devcenter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@
"description": "Project details.",
"type": "object",
"properties": {
"id": {
"description": "The ID of the project",
"uri": {
"description": "The unique URI of the project",
"type": "string"
},
"name": {
Expand All @@ -165,7 +165,7 @@
}
},
"required": [
"id",
"uri",
"name"
]
},
Expand Down
149 changes: 85 additions & 64 deletions ...ion/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/environments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,20 +310,23 @@
}
}
},
"/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults": {
"/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": {
"get": {
"tags": [
"ActionResults",
"EnvironmentOperations",
"Environments"
],
"description": "Lists the action results for an environment.",
"description": "Lists operations on the environment which have occurred within the past 30 days",
"parameters": [
{
"$ref": "devcenter.json#/parameters/ApiVersionParameter"
},
{
"$ref": "devcenter.json#/parameters/TopParameter"
},
{
"$ref": "devcenter.json#/parameters/FilterParameter"
},
{
"$ref": "devcenter.json#/parameters/ProjectNameParameter"
},
Expand All @@ -334,12 +337,12 @@
"$ref": "#/parameters/EnvironmentNameParameter"
}
],
"operationId": "EnvironmentActionResults_ListByEnvironment",
"operationId": "EnvironmentOperations_ListByEnvironment",
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ActionResultListResult"
"$ref": "#/definitions/EnvironmentOperationListResult"
}
},
"default": {
Expand All @@ -356,19 +359,19 @@
}
},
"x-ms-examples": {
"EnvironmentActionResults_ListByEnvironment": {
"$ref": "./examples/EnvironmentActionResults_ListByEnvironment.json"
"EnvironmentOperations_ListByEnvironment": {
"$ref": "./examples/EnvironmentOperations_ListByEnvironment.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults/{actionResultName}": {
"/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}": {
"get": {
"tags": [
"ActionResults",
"EnvironmentOperations",
"Environments"
],
"description": "Gets an environment action result.",
Expand All @@ -386,15 +389,15 @@
"$ref": "#/parameters/EnvironmentNameParameter"
},
{
"$ref": "#/parameters/ActionResultNameParameter"
"$ref": "#/parameters/EnvironmentOperationIdParameter"
}
],
"operationId": "EnvironmentActionResults_GetByEnvironment",
"operationId": "EnvironmentOperations_GetByEnvironment",
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ActionResult"
"$ref": "#/definitions/EnvironmentOperation"
}
},
"default": {
Expand All @@ -411,19 +414,19 @@
}
},
"x-ms-examples": {
"EnvironmentActionResults_GetByEnvironment": {
"$ref": "./examples/EnvironmentActionResults_GetByEnvironment.json"
"EnvironmentOperations_GetByEnvironment": {
"$ref": "./examples/EnvironmentOperations_GetByEnvironment.json"
}
}
}
},
"/projects/{projectName}/users/{userId}/environments/{environmentName}/actionResults/{actionResultName}/logs": {
"/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs": {
"get": {
"tags": [
"ActionResults",
"EnvironmentOperations",
"Environments"
],
"description": "Gets the logs for an action on an environment.",
"description": "Gets the logs for an operation on an environment.",
"produces": [
"text/plain"
],
Expand All @@ -441,22 +444,21 @@
"$ref": "#/parameters/EnvironmentNameParameter"
},
{
"$ref": "#/parameters/ActionResultNameParameter"
"$ref": "#/parameters/EnvironmentOperationIdParameter"
}
],
"operationId": "EnvironmentActionResults_GetLogs",
"operationId": "EnvironmentOperations_GetLogs",
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"type": "string",
"format": "byte"
"type": "file"
}
}
},
"x-ms-examples": {
"EnvironmentActionResults_GetLogs": {
"$ref": "./examples/EnvironmentActionResults_GetLogs.json"
"EnvironmentOperations_GetLogs": {
"$ref": "./examples/EnvironmentOperations_GetLogs.json"
}
}
}
Expand Down Expand Up @@ -770,8 +772,8 @@
}
],
"properties": {
"id": {
"description": "The ID of the environment",
"uri": {
"description": "The unique URI of the environment",
"type": "string",
"readOnly": true
},
Expand Down Expand Up @@ -875,8 +877,8 @@
"description": "A catalog.",
"type": "object",
"properties": {
"id": {
"description": "The ID of the catalog",
"uri": {
"description": "The unique URI of the catalog",
"type": "string"
},
"name": {
Expand All @@ -885,7 +887,7 @@
}
},
"required": [
"id",
"uri",
"name"
]
},
Expand Down Expand Up @@ -913,6 +915,10 @@
"description": "An environment definition.",
"type": "object",
"properties": {
"uri": {
"description": "The unique URI of the environment definition",
"type": "string"
},
"id": {
"description": "The ID of the environment definition.",
"type": "string"
Expand Down Expand Up @@ -947,6 +953,7 @@
},
"required": [
"name",
"uri",
"catalogName",
"id"
]
Expand Down Expand Up @@ -1023,16 +1030,16 @@
"description": "Properties of an environment type.",
"type": "object",
"properties": {
"id": {
"description": "The ID of the environment type",
"uri": {
"description": "The unique URI of the environment type",
"type": "string"
},
"name": {
"description": "Name of the environment type",
"type": "string"
},
"deploymentTargetId": {
"description": "Id of a subscription or management group that the environment type will be mapped to. The environment's resources will be deployed into this subscription or management group.",
"description": "The ID of a subscription or management group that the environment type will be mapped to. The environment's resources will be deployed into this subscription or management group.",
"type": "string"
},
"status": {
Expand All @@ -1041,7 +1048,7 @@
}
},
"required": [
"id",
"uri",
"name",
"deploymentTargetId",
"status"
Expand Down Expand Up @@ -1111,15 +1118,15 @@
]
}
},
"ActionResultListResult": {
"EnvironmentOperationListResult": {
"type": "object",
"description": "The action results list result.",
"properties": {
"value": {
"description": "The current page of results.",
"type": "array",
"items": {
"$ref": "#/definitions/ActionResult"
"$ref": "#/definitions/EnvironmentOperation"
}
},
"nextLink": {
Expand All @@ -1131,57 +1138,71 @@
"value"
]
},
"ActionResult": {
"EnvironmentOperation": {
"type": "object",
"description": "The result of an action on an environment.",
"description": "Information about an operation on an environment.",
"properties": {
"id": {
"description": "Unique identifier for the environment action.",
"type": "string",
"readOnly": true
"uri": {
"description": "The unique URI for the environment operation.",
"type": "string"
},
"name": {
"description": "The name of the action.",
"type": "string",
"readOnly": true
"operationId": {
"description": "Unique identifier for the environment operation.",
"type": "string"
},
"kind": {
"description": "The kind of action that was taken.",
"type": "string",
"readOnly": true
"description": "The kind of operation that occurred.",
"$ref": "#/definitions/EnvironmentOperationKind"
},
"status": {
"description": "The action status.",
"type": "string",
"readOnly": true
"description": "The operation status.",
chrissmiller marked this conversation as resolved.
Show resolved Hide resolved
"type": "string"
},
"parameters": {
"type": "object",
"description": "Parameters object for the action.",
"readOnly": true
"description": "Parameters object for the operation."
},
"createdByObjectId": {
"description": "The object ID of the actor which initiated the action'.",
"type": "string",
"readOnly": true
"description": "The object ID of the actor which initiated the operation.",
"type": "string"
},
"startTime": {
"description": "The time the action started.",
"description": "The time the operation started.",
"type": "string",
"readOnly": true,
"format": "date-time"
},
"endTime": {
"description": "The time the action finished.",
"description": "The time the operation finished.",
"type": "string",
"readOnly": true,
"format": "date-time"
},
"error": {
"description": "Provisioning or action error details. Populated only for error states.",
"readOnly": true,
"description": "Provisioning or operation error details. Populated only for error states.",
"$ref": "devcenter.json#/definitions/CloudErrorBody"
}
},
"required": [
"uri",
"operationId",
"kind",
"status"
]
},
"EnvironmentOperationKind": {
"type": "string",
"enum": [
"Deployment"
],
"description": "The type of environment operation.",
"x-ms-enum": {
"name": "EnvironmentOperationKind",
"modelAsString": true,
"values": [
{
"value": "Deployment",
"description": "The operation represents a deployment."
}
]
}
}
},
Expand Down Expand Up @@ -1219,15 +1240,15 @@
"description": "The name of the environment definition",
"x-ms-parameter-location": "method"
},
"ActionResultNameParameter": {
"name": "actionResultName",
"EnvironmentOperationIdParameter": {
"name": "operationId",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$",
"minLength": 3,
"maxLength": 63,
"description": "The name of the action to check the result for.",
"description": "The id of the operation on an environment.",
"x-ms-parameter-location": "method"
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...nter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"responses": {
"200": {
"body": {
"id": "/projects/myProject/catalogs/foo",
"uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo",
"name": "foo"
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/Catalogs_ListByProject.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"body": {
"value": [
{
"id": "/projects/myProject/catalogs/foo",
"uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo",
"name": "foo"
}
]
Expand Down
2 changes: 1 addition & 1 deletion ...ta-plane/Microsoft.DevCenter/preview/2023-07-01-preview/examples/DevBoxActions_Delay.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"responses": {
"200": {
"body": {
"id": "/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/myDevBox/actions/schedule-default",
"uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default",
"name": "schedule-default",
"actionType": "Stop",
"sourceId": "/projects/myProject/pools/myPool/schedules/default",
Expand Down
Loading