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

Workspaces: Swagger correctness #12730

Merged
merged 3 commits into from
Mar 1, 2021
Merged

Workspaces: Swagger correctness #12730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6db71dd
Swagger correctness for Workspaces
yoramsinger Jan 29, 2021
4b2358c
Workspaces 2020-08-01
yoramsinger Jan 29, 2021
16d4c10
Merge branch 'master' into la-20210129-workspaces
yoramsinger Feb 24, 2021
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
128 changes: 100 additions & 28 deletions ...insights/resource-manager/Microsoft.OperationalInsights/stable/2020-08-01/Workspaces.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@
"description": "Gets the workspaces in a subscription.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
Expand All @@ -60,6 +60,12 @@
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
Expand All @@ -81,13 +87,13 @@
"description": "Gets workspaces in a resource group.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
Expand All @@ -96,6 +102,12 @@
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
Expand All @@ -117,7 +129,7 @@
"description": "Create or update a workspace.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
Expand All @@ -132,10 +144,10 @@
"description": "The parameters required to create or update a workspace."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
Expand All @@ -153,6 +165,12 @@
},
"202": {
"description": "Accepted"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true
Expand All @@ -170,16 +188,16 @@
"description": "Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "force",
Expand All @@ -198,6 +216,12 @@
},
"204": {
"description": "NoContent response definition."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true
Expand All @@ -215,16 +239,16 @@
"description": "Gets a workspace instance.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
Expand All @@ -233,6 +257,12 @@
"schema": {
"$ref": "#/definitions/Workspace"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
}
},
Expand All @@ -249,7 +279,7 @@
"description": "Updates a workspace.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
Expand All @@ -264,10 +294,10 @@
"description": "The parameters required to patch a workspace."
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
Expand All @@ -276,6 +306,12 @@
"schema": {
"$ref": "#/definitions/Workspace"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
}
}
Expand All @@ -294,10 +330,10 @@
"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/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
Expand All @@ -306,6 +342,12 @@
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
Expand All @@ -327,13 +369,13 @@
"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/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
Expand All @@ -342,6 +384,12 @@
"schema": {
"$ref": "#/definitions/WorkspaceListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
Expand All @@ -363,7 +411,8 @@
"PerNode",
"PerGB2018",
"Standalone",
"CapacityReservation"
"CapacityReservation",
"LACluster"
],
"x-ms-enum": {
"name": "WorkspaceSkuNameEnum",
Expand Down Expand Up @@ -481,14 +530,23 @@
"retentionInDays": {
"type": "integer",
"format": "int32",
"minimum": 30,
"maximum": 730,
"description": "The workspace data retention in days, between 30 and 730."
"x-nullable": true,
"description": "The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details."
},
"workspaceCapping": {
"$ref": "#/definitions/WorkspaceCapping",
"description": "The daily volume cap for ingestion."
},
"createdDate": {
"type": "string",
"description": "Workspace creation date.",
"readOnly": true
},
"modifiedDate": {
"type": "string",
"description": "Workspace modification date.",
"readOnly": true
},
"publicNetworkAccessForIngestion": {
"description": "The network access type for accessing Log Analytics ingestion.",
"$ref": "#/definitions/PublicNetworkAccessType"
Expand All @@ -497,17 +555,31 @@
"description": "The network access type for accessing Log Analytics query.",
"$ref": "#/definitions/PublicNetworkAccessType"
},
"forceCmkForQuery": {
"type": "boolean",
"description": "Indicates whether customer managed storage is mandatory for query management."
},
"privateLinkScopedResources": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "#/definitions/PrivateLinkScopedResource"
},
"description": "List of linked private link scope resources."
},
"features": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/WorkspaceFeatures",
"description": "Workspace features."
}
},
"description": "Workspace properties."
},
"WorkspaceFeatures": {
"properties": {},
"additionalProperties": true,
"description": "Workspace features."
},
"PrivateLinkScopedResource": {
"properties": {
"resourceId": {
Expand Down Expand Up @@ -535,7 +607,7 @@
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource"
}
],
"description": "The top level Workspace resource container."
Expand All @@ -562,7 +634,7 @@
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource"
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/AzureEntityResource"
}
],
"description": "The top level Workspace resource container."
Expand Down
25 changes: 22 additions & 3 deletions ...insights/resource-manager/Microsoft.OperationalInsights/stable/2020-10-01/Workspaces.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,14 +530,23 @@
"retentionInDays": {
"type": "integer",
"format": "int32",
"minimum": 30,
"maximum": 730,
"description": "The workspace data retention in days, between 30 and 730."
"x-nullable": true,
"description": "The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details."
},
"workspaceCapping": {
"$ref": "#/definitions/WorkspaceCapping",
"description": "The daily volume cap for ingestion."
},
"createdDate": {
"type": "string",
"description": "Workspace creation date.",
"readOnly": true
},
"modifiedDate": {
"type": "string",
"description": "Workspace modification date.",
"readOnly": true
},
"publicNetworkAccessForIngestion": {
"description": "The network access type for accessing Log Analytics ingestion.",
"$ref": "#/definitions/PublicNetworkAccessType"
Expand All @@ -557,10 +566,20 @@
"$ref": "#/definitions/PrivateLinkScopedResource"
},
"description": "List of linked private link scope resources."
},
"features": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/WorkspaceFeatures",
"description": "Workspace features."
}
},
"description": "Workspace properties."
},
"WorkspaceFeatures": {
"properties": {},
"additionalProperties": true,
"description": "Workspace features."
},
"PrivateLinkScopedResource": {
"properties": {
"resourceId": {
Expand Down