Skip to content

Add DeletedWorkspaces API #9401

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

Merged
mmyyrroonn merged 1 commit into from
May 13, 2020
Merged

Add DeletedWorkspaces API #9401

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 69 additions & 0 deletions ...resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,75 @@
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.OperationalInsights/deletedWorkspaces": {
Copy link
Member

@majastrz majastrz May 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deletedWorkspaces [](start = 77, length = 17)

Is this going to be a proxy or tracked resource?

Copy link
Contributor Author

@yoramsinger yoramsinger May 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a proxy resource that references a recently deleted tracked resource. When a user takes such resource and do a PUT on it, it will be recovered.

"get": {
"tags": [
"DeletedWorkspaces"
],
"x-ms-examples": {
"WorkspacesSubscriptionList": {
Copy link
Contributor

@mmyyrroonn mmyyrroonn May 11, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know the payload might be same. Could we change the name of examples?

Copy link
Contributor Author

@yoramsinger yoramsinger May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the same payload for this version.

"$ref": "./examples/WorkspacesSubscriptionList.json"
}
},
"operationId": "DeletedWorkspaces_List",
"description": "Gets recently deleted workspaces in a subscription, available for recovery.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK response definition.",
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
}
},
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/deletedWorkspaces": {
"get": {
"tags": [
"DeletedWorkspaces"
],
"x-ms-examples": {
"WorkspacesGet": {
Copy link
Contributor

@mmyyrroonn mmyyrroonn May 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Copy link
Contributor Author

@yoramsinger yoramsinger May 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the same payload for this version.

"$ref": "./examples/WorkspacesListByResourceGroup.json"
}
},
"operationId": "DeletedWorkspaces_ListByResourceGroup",
"description": "Gets recently deleted workspaces in a resource group, available for recovery.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK response definition.",
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": null
Copy link
Member

@majastrz majastrz May 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

null [](start = 26, length = 4)

You should consider declaring paging in the swagger even if the service doesn't support it. This way you can just add it in the service when needed and clients will just work the same. (Same for the above API as well.)

Copy link
Contributor Author

@yoramsinger yoramsinger May 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We consider adding such support in the future for Workspaces, we will add it then for DeletedWorkspaces as well, since it is the same code in the service. We prefer to keep it this way for now.

Copy link
Member

@majastrz majastrz May 9, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm only suggesting a swagger change. If your backend doesn't support paging it's as if it always returns 1 page, but it's not required at this point.

In reply to: 422477036 [](ancestors = 422477036)

}
}
}
},
"definitions": {
Expand Down