{ "swagger": "2.0", "info": { "title": "Azure API Center", "version": "2024-03-01", "description": "Azure API Center Resource Provider.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "Services" }, { "name": "MetadataSchemas" }, { "name": "Workspaces" }, { "name": "Apis" }, { "name": "ApiVersions" }, { "name": "ApiDefinitions" }, { "name": "Deployments" }, { "name": "Environments" } ], "paths": { "/providers/Microsoft.ApiCenter/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List Provider Operations": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ApiCenter/services": { "get": { "operationId": "Services_ListBySubscription", "tags": [ "Services" ], "description": "Lists services within an Azure subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Services_ListBySubscription": { "$ref": "./examples/Services_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services": { "get": { "operationId": "Services_ListByResourceGroup", "tags": [ "Services" ], "description": "Returns a collection of services within the resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServiceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Services_ListByResourceGroup": { "$ref": "./examples/Services_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}": { "get": { "operationId": "Services_Get", "tags": [ "Services" ], "description": "Returns details of the service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Service" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Services_Get": { "$ref": "./examples/Services_Get.json" } } }, "put": { "operationId": "Services_CreateOrUpdate", "tags": [ "Services" ], "description": "Creates new or updates existing API.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Service" } } ], "responses": { "200": { "description": "Resource 'Service' update operation succeeded", "schema": { "$ref": "#/definitions/Service" } }, "201": { "description": "Resource 'Service' create operation succeeded", "schema": { "$ref": "#/definitions/Service" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Services_CreateOrUpdate": { "$ref": "./examples/Services_CreateOrUpdate.json" } } }, "patch": { "operationId": "Services_Update", "tags": [ "Services" ], "description": "Updates existing service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/ServiceUpdate" }, "x-ms-client-name": "properties" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Service" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Services_Update": { "$ref": "./examples/Services_Update.json" } } }, "delete": { "operationId": "Services_Delete", "tags": [ "Services" ], "description": "Deletes specified service.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Services_Delete": { "$ref": "./examples/Services_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/exportMetadataSchema": { "post": { "operationId": "Services_ExportMetadataSchema", "tags": [ "Services" ], "description": "Exports the effective metadata schema.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/MetadataSchemaExportRequest" }, "x-ms-client-name": "body" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MetadataSchemaExportResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Services_ExportMetadataSchema": { "$ref": "./examples/Services_ExportMetadataSchema.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas": { "get": { "operationId": "MetadataSchemas_List", "tags": [ "MetadataSchemas" ], "description": "Returns a collection of metadata schemas.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MetadataSchemaListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MetadataSchemas_ListByService": { "$ref": "./examples/MetadataSchemas_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas/{metadataSchemaName}": { "get": { "operationId": "MetadataSchemas_Get", "tags": [ "MetadataSchemas" ], "description": "Returns details of the metadata schema.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "metadataSchemaName", "in": "path", "description": "The name of the metadata schema.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MetadataSchema" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MetadataSchemas_Get": { "$ref": "./examples/MetadataSchemas_Get.json" } } }, "put": { "operationId": "MetadataSchemas_CreateOrUpdate", "tags": [ "MetadataSchemas" ], "description": "Creates new or updates existing metadata schema.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "metadataSchemaName", "in": "path", "description": "The name of the metadata schema.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/MetadataSchema" }, "x-ms-client-name": "resource" } ], "responses": { "200": { "description": "Resource 'MetadataSchema' update operation succeeded", "schema": { "$ref": "#/definitions/MetadataSchema" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "201": { "description": "Resource 'MetadataSchema' create operation succeeded", "schema": { "$ref": "#/definitions/MetadataSchema" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MetadataSchemas_CreateOrUpdate": { "$ref": "./examples/MetadataSchemas_CreateOrUpdate.json" } } }, "delete": { "operationId": "MetadataSchemas_Delete", "tags": [ "MetadataSchemas" ], "description": "Deletes specified metadata schema.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "metadataSchemaName", "in": "path", "description": "The name of the metadata schema.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MetadataSchemas_Delete": { "$ref": "./examples/MetadataSchemas_Delete.json" } } }, "head": { "operationId": "MetadataSchemas_Head", "tags": [ "MetadataSchemas" ], "description": "Checks if specified metadata schema exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "metadataSchemaName", "in": "path", "description": "The name of the metadata schema.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "MetadataSchemas_Head": { "$ref": "./examples/MetadataSchemas_Head.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces": { "get": { "operationId": "Workspaces_List", "tags": [ "Workspaces" ], "description": "Returns a collection of workspaces.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_ListByService": { "$ref": "./examples/Workspaces_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}": { "get": { "operationId": "Workspaces_Get", "tags": [ "Workspaces" ], "description": "Returns details of the workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_Get": { "$ref": "./examples/Workspaces_Get.json" } } }, "put": { "operationId": "Workspaces_CreateOrUpdate", "tags": [ "Workspaces" ], "description": "Creates new or updates existing workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Workspace" }, "x-ms-client-name": "resource" } ], "responses": { "200": { "description": "Resource 'Workspace' update operation succeeded", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "201": { "description": "Resource 'Workspace' create operation succeeded", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_CreateOrUpdate": { "$ref": "./examples/Workspaces_CreateOrUpdate.json" } } }, "delete": { "operationId": "Workspaces_Delete", "tags": [ "Workspaces" ], "description": "Deletes specified workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_Delete": { "$ref": "./examples/Workspaces_Delete.json" } } }, "head": { "operationId": "Workspaces_Head", "tags": [ "Workspaces" ], "description": "Checks if specified workspace exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Workspaces_Head": { "$ref": "./examples/Workspaces_Head.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis": { "get": { "operationId": "Apis_List", "tags": [ "Apis" ], "description": "Returns a collection of APIs.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApiListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Apis_ListByWorkspace": { "$ref": "./examples/Apis_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}": { "get": { "operationId": "Apis_Get", "tags": [ "Apis" ], "description": "Returns details of the API.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Api" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Apis_Get": { "$ref": "./examples/Apis_Get.json" } } }, "put": { "operationId": "Apis_CreateOrUpdate", "tags": [ "Apis" ], "description": "Creates new or updates existing API.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Api" }, "x-ms-client-name": "resource" } ], "responses": { "200": { "description": "Resource 'Api' update operation succeeded", "schema": { "$ref": "#/definitions/Api" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "201": { "description": "Resource 'Api' create operation succeeded", "schema": { "$ref": "#/definitions/Api" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Apis_CreateOrUpdate": { "$ref": "./examples/Apis_CreateOrUpdate.json" } } }, "delete": { "operationId": "Apis_Delete", "tags": [ "Apis" ], "description": "Deletes specified API.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Apis_Delete": { "$ref": "./examples/Apis_Delete.json" } } }, "head": { "operationId": "Apis_Head", "tags": [ "Apis" ], "description": "Checks if specified API exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Apis_Head": { "$ref": "./examples/Apis_Head.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments": { "get": { "operationId": "Deployments_List", "tags": [ "Deployments" ], "description": "Returns a collection of API deployments.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deployments_ListByApi": { "$ref": "./examples/Deployments_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}": { "get": { "operationId": "Deployments_Get", "tags": [ "Deployments" ], "description": "Returns details of the API deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "deploymentName", "in": "path", "description": "The name of the API deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Deployment" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deployments_Get": { "$ref": "./examples/Deployments_Get.json" } } }, "put": { "operationId": "Deployments_CreateOrUpdate", "tags": [ "Deployments" ], "description": "Creates new or updates existing API deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "deploymentName", "in": "path", "description": "The name of the API deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Deployment" }, "x-ms-client-name": "resource" } ], "responses": { "200": { "description": "Resource 'Deployment' update operation succeeded", "schema": { "$ref": "#/definitions/Deployment" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "201": { "description": "Resource 'Deployment' create operation succeeded", "schema": { "$ref": "#/definitions/Deployment" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deployments_CreateOrUpdate": { "$ref": "./examples/Deployments_CreateOrUpdate.json" } } }, "delete": { "operationId": "Deployments_Delete", "tags": [ "Deployments" ], "description": "Deletes API deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "deploymentName", "in": "path", "description": "The name of the API deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deployments_Delete": { "$ref": "./examples/Deployments_Delete.json" } } }, "head": { "operationId": "Deployments_Head", "tags": [ "Deployments" ], "description": "Checks if specified API deployment exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "deploymentName", "in": "path", "description": "The name of the API deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deployments_Head": { "$ref": "./examples/Deployments_Head.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions": { "get": { "operationId": "ApiVersions_List", "tags": [ "ApiVersions" ], "description": "Returns a collection of API versions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApiVersionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiVersions_ListByApi": { "$ref": "./examples/ApiVersions_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}": { "get": { "operationId": "ApiVersions_Get", "tags": [ "ApiVersions" ], "description": "Returns details of the API version.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApiVersion" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiVersions_Get": { "$ref": "./examples/ApiVersions_Get.json" } } }, "put": { "operationId": "ApiVersions_CreateOrUpdate", "tags": [ "ApiVersions" ], "description": "Creates new or updates existing API version.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/ApiVersion" }, "x-ms-client-name": "resource" } ], "responses": { "200": { "description": "Resource 'ApiVersion' update operation succeeded", "schema": { "$ref": "#/definitions/ApiVersion" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "201": { "description": "Resource 'ApiVersion' create operation succeeded", "schema": { "$ref": "#/definitions/ApiVersion" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiVersions_CreateOrUpdate": { "$ref": "./examples/ApiVersions_CreateOrUpdate.json" } } }, "delete": { "operationId": "ApiVersions_Delete", "tags": [ "ApiVersions" ], "description": "Deletes specified API version", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiVersions_Delete": { "$ref": "./examples/ApiVersions_Delete.json" } } }, "head": { "operationId": "ApiVersions_Head", "tags": [ "ApiVersions" ], "description": "Checks if specified API version exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiVersions_Head": { "$ref": "./examples/ApiVersions_Head.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions": { "get": { "operationId": "ApiDefinitions_List", "tags": [ "ApiDefinitions" ], "description": "Returns a collection of API definitions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApiDefinitionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiDefinitions_ListByApiVersion": { "$ref": "./examples/ApiDefinitions_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}": { "get": { "operationId": "ApiDefinitions_Get", "tags": [ "ApiDefinitions" ], "description": "Returns details of the API definition.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "definitionName", "in": "path", "description": "The name of the API definition.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApiDefinition" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiDefinitions_Get": { "$ref": "./examples/ApiDefinitions_Get.json" } } }, "put": { "operationId": "ApiDefinitions_CreateOrUpdate", "tags": [ "ApiDefinitions" ], "description": "Creates new or updates existing API definition.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "definitionName", "in": "path", "description": "The name of the API definition.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/ApiDefinition" }, "x-ms-client-name": "resource" } ], "responses": { "200": { "description": "Resource 'ApiDefinition' update operation succeeded", "schema": { "$ref": "#/definitions/ApiDefinition" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "201": { "description": "Resource 'ApiDefinition' create operation succeeded", "schema": { "$ref": "#/definitions/ApiDefinition" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiDefinitions_CreateOrUpdate": { "$ref": "./examples/ApiDefinitions_CreateOrUpdate.json" } } }, "delete": { "operationId": "ApiDefinitions_Delete", "tags": [ "ApiDefinitions" ], "description": "Deletes specified API definition.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "definitionName", "in": "path", "description": "The name of the API definition.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiDefinitions_Delete": { "$ref": "./examples/ApiDefinitions_Delete.json" } } }, "head": { "operationId": "ApiDefinitions_Head", "tags": [ "ApiDefinitions" ], "description": "Checks if specified API definition exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "definitionName", "in": "path", "description": "The name of the API definition.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiDefinitions_Head": { "$ref": "./examples/ApiDefinitions_Head.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/exportSpecification": { "post": { "operationId": "ApiDefinitions_ExportSpecification", "tags": [ "ApiDefinitions" ], "description": "Exports the API specification.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "definitionName", "in": "path", "description": "The name of the API definition.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApiSpecExportResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiDefinitions_ExportSpecification": { "$ref": "./examples/ApiDefinitions_ExportSpecification.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}/versions/{versionName}/definitions/{definitionName}/importSpecification": { "post": { "operationId": "ApiDefinitions_ImportSpecification", "tags": [ "ApiDefinitions" ], "description": "Imports the API specification.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "apiName", "in": "path", "description": "The name of the API.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "versionName", "in": "path", "description": "The name of the API version.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "definitionName", "in": "path", "description": "The name of the API definition.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/ApiSpecImportRequest" }, "x-ms-client-name": "body" } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ApiDefinitions_ImportSpecification": { "$ref": "./examples/ApiDefinitions_ImportSpecification.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments": { "get": { "operationId": "Environments_List", "tags": [ "Environments" ], "description": "Returns a collection of environments.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "$ref": "#/parameters/OdataFilterParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnvironmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Environments_ListByWorkspace": { "$ref": "./examples/Environments_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/environments/{environmentName}": { "get": { "operationId": "Environments_Get", "tags": [ "Environments" ], "description": "Returns details of the environment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "environmentName", "in": "path", "description": "The name of the environment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Environment" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Environments_Get": { "$ref": "./examples/Environments_Get.json" } } }, "put": { "operationId": "Environments_CreateOrUpdate", "tags": [ "Environments" ], "description": "Creates new or updates existing environment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "environmentName", "in": "path", "description": "The name of the environment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "payload", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Environment" }, "x-ms-client-name": "resource" } ], "responses": { "200": { "description": "Resource 'Environment' update operation succeeded", "schema": { "$ref": "#/definitions/Environment" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "201": { "description": "Resource 'Environment' create operation succeeded", "schema": { "$ref": "#/definitions/Environment" }, "headers": { "ETag": { "type": "string", "description": "The entity tag for the response." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Environments_CreateOrUpdate": { "$ref": "./examples/Environments_CreateOrUpdate.json" } } }, "delete": { "operationId": "Environments_Delete", "tags": [ "Environments" ], "description": "Deletes the environment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "environmentName", "in": "path", "description": "The name of the environment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Environments_Delete": { "$ref": "./examples/Environments_Delete.json" } } }, "head": { "operationId": "Environments_Head", "tags": [ "Environments" ], "description": "Checks if specified environment exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serviceName", "in": "path", "description": "The name of Azure API Center service.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "workspaceName", "in": "path", "description": "The name of the workspace.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" }, { "name": "environmentName", "in": "path", "description": "The name of the environment.", "required": true, "type": "string", "minLength": 1, "maxLength": 90, "pattern": "^[a-zA-Z0-9-]{3,90}$" } ], "responses": { "200": { "description": "The request has succeeded." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Environments_Head": { "$ref": "./examples/Environments_Head.json" } } } } }, "definitions": { "ActionType": { "type": "string", "description": "The type of action", "enum": [ "Internal" ], "x-ms-enum": { "name": "ActionType", "modelAsString": true, "values": [ { "name": "Internal", "value": "Internal", "description": "an internal action" } ] } }, "Api": { "type": "object", "description": "API entity.", "properties": { "properties": { "$ref": "#/definitions/ApiProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ApiDefinition": { "type": "object", "description": "API definition entity.", "properties": { "properties": { "$ref": "#/definitions/ApiDefinitionProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ApiDefinitionListResult": { "type": "object", "description": "The response of a ApiDefinition list operation.", "properties": { "value": { "type": "array", "description": "The ApiDefinition items on this page", "items": { "$ref": "#/definitions/ApiDefinition" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "ApiDefinitionProperties": { "type": "object", "description": "API definition properties entity.", "properties": { "title": { "type": "string", "description": "API definition title.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "API definition description." }, "specification": { "$ref": "#/definitions/ApiDefinitionPropertiesSpecification", "description": "API specification details.", "readOnly": true } }, "required": [ "title" ] }, "ApiDefinitionPropertiesSpecification": { "type": "object", "description": "API specification details.", "properties": { "name": { "type": "string", "description": "Specification name." }, "version": { "type": "string", "description": "Specification version." } } }, "ApiKind": { "type": "string", "description": "The kind of the API", "enum": [ "rest", "graphql", "grpc", "soap", "webhook", "websocket" ], "x-ms-enum": { "name": "ApiKind", "modelAsString": true, "values": [ { "name": "rest", "value": "rest", "description": "A Representational State Transfer Api" }, { "name": "graphql", "value": "graphql", "description": "A Graph query language Api" }, { "name": "grpc", "value": "grpc", "description": "A gRPC Api" }, { "name": "soap", "value": "soap", "description": "A SOAP Api" }, { "name": "webhook", "value": "webhook", "description": "Web Hook" }, { "name": "websocket", "value": "websocket", "description": "Web Socket" } ] } }, "ApiListResult": { "type": "object", "description": "The response of a Api list operation.", "properties": { "value": { "type": "array", "description": "The Api items on this page", "items": { "$ref": "#/definitions/Api" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "ApiProperties": { "type": "object", "description": "API properties.", "properties": { "title": { "type": "string", "description": "API title.", "minLength": 1, "maxLength": 50 }, "kind": { "$ref": "#/definitions/ApiKind", "description": "Kind of API. For example, REST or GraphQL." }, "description": { "type": "string", "description": "Description of the API.", "maxLength": 1000 }, "summary": { "type": "string", "description": "Short description of the API.", "maxLength": 200 }, "lifecycleStage": { "$ref": "#/definitions/LifecycleStage", "description": "Current lifecycle stage of the API.", "readOnly": true }, "termsOfService": { "$ref": "#/definitions/TermsOfService", "description": "Terms of service for the API." }, "externalDocumentation": { "type": "array", "description": "The set of external documentation", "maxItems": 20, "items": { "$ref": "#/definitions/ExternalDocumentation" }, "x-ms-identifiers": [] }, "contacts": { "type": "array", "description": "The set of contacts", "items": { "$ref": "#/definitions/Contact" }, "x-ms-identifiers": [] }, "license": { "$ref": "#/definitions/License", "description": "The license information for the API." }, "customProperties": { "$ref": "#/definitions/CustomProperties", "description": "The custom metadata defined for API catalog entities." } }, "required": [ "title", "kind" ] }, "ApiSpecExportResult": { "type": "object", "description": "The API specification export result.", "properties": { "format": { "$ref": "#/definitions/ApiSpecExportResultFormat", "description": "The format of exported result" }, "value": { "type": "string", "description": "The result of the export operation." } } }, "ApiSpecExportResultFormat": { "type": "string", "description": "Result format for exported Api spec", "enum": [ "inline", "link" ], "x-ms-enum": { "name": "ApiSpecExportResultFormat", "modelAsString": true, "values": [ { "name": "inline", "value": "inline", "description": "The inlined content of a specification document." }, { "name": "link", "value": "link", "description": "The link to the result of the export operation. The URL is valid for 5 minutes." } ] } }, "ApiSpecImportRequest": { "type": "object", "description": "The API specification source entity properties.", "properties": { "value": { "type": "string", "description": "Value of the API specification source." }, "format": { "$ref": "#/definitions/ApiSpecImportSourceFormat", "description": "Format of the API specification source." }, "specification": { "$ref": "#/definitions/ApiSpecImportRequestSpecification", "description": "API specification details." } } }, "ApiSpecImportRequestSpecification": { "type": "object", "description": "API specification details.", "properties": { "name": { "type": "string", "description": "Specification name." }, "version": { "type": "string", "description": "Specification version." } } }, "ApiSpecImportSourceFormat": { "type": "string", "description": "Source format for imported Api spec", "enum": [ "inline", "link" ], "x-ms-enum": { "name": "ApiSpecImportSourceFormat", "modelAsString": true, "values": [ { "name": "inline", "value": "inline", "description": "The inlined content of a specification document." }, { "name": "link", "value": "link", "description": "The link to a specification document hosted on a publicly accessible internet\naddress." } ] } }, "ApiVersion": { "type": "object", "description": "API version entity.", "properties": { "properties": { "$ref": "#/definitions/ApiVersionProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ApiVersionListResult": { "type": "object", "description": "The response of a ApiVersion list operation.", "properties": { "value": { "type": "array", "description": "The ApiVersion items on this page", "items": { "$ref": "#/definitions/ApiVersion" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "ApiVersionProperties": { "type": "object", "description": "API version properties entity.", "properties": { "title": { "type": "string", "description": "API version title.", "minLength": 1, "maxLength": 50 }, "lifecycleStage": { "$ref": "#/definitions/LifecycleStage", "description": "Current lifecycle stage of the API." } }, "required": [ "title", "lifecycleStage" ] }, "Contact": { "type": "object", "description": "Contact information", "properties": { "name": { "type": "string", "description": "Name of the contact.", "maxLength": 100 }, "url": { "type": "string", "format": "uri", "description": "URL for the contact.", "maxLength": 200 }, "email": { "type": "string", "description": "Email address of the contact.", "maxLength": 100 } } }, "CreatedByType": { "type": "string", "description": "How the resource was created", "enum": [ "User", "Application", "ManagedIdentity", "Key" ], "x-ms-enum": { "name": "CreatedByType", "modelAsString": true, "values": [ { "name": "User", "value": "User", "description": "Created by user" }, { "name": "Application", "value": "Application", "description": "Created by Application" }, { "name": "ManagedIdentity", "value": "ManagedIdentity", "description": "Created by Managed Identity" }, { "name": "Key", "value": "Key", "description": "Created By Key" } ] } }, "CustomProperties": { "type": "object", "title": "Custom Properties", "description": "The custom metadata defined for API catalog entities." }, "Deployment": { "type": "object", "description": "API deployment entity.", "properties": { "properties": { "$ref": "#/definitions/DeploymentProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "DeploymentListResult": { "type": "object", "description": "The response of a Deployment list operation.", "properties": { "value": { "type": "array", "description": "The Deployment items on this page", "items": { "$ref": "#/definitions/Deployment" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "DeploymentProperties": { "type": "object", "description": "API deployment entity properties.", "properties": { "title": { "type": "string", "description": "API deployment title", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "Description of the deployment.", "maxLength": 500 }, "environmentId": { "type": "string", "description": "API center-scoped environment resource ID." }, "definitionId": { "type": "string", "description": "API center-scoped definition resource ID." }, "state": { "$ref": "#/definitions/DeploymentState", "description": "State of API deployment." }, "server": { "$ref": "#/definitions/DeploymentServer", "description": "The deployment server" }, "customProperties": { "$ref": "#/definitions/CustomProperties", "description": "The custom metadata defined for API catalog entities." } } }, "DeploymentServer": { "type": "object", "description": "Server", "properties": { "runtimeUri": { "type": "array", "description": "Base runtime URLs for this deployment.", "items": { "$ref": "#/definitions/SmallString" } } } }, "DeploymentState": { "type": "string", "description": "State of the Deployment", "enum": [ "active", "inactive" ], "x-ms-enum": { "name": "DeploymentState", "modelAsString": true, "values": [ { "name": "active", "value": "active", "description": "Active State" }, { "name": "inactive", "value": "inactive", "description": "Inactive State" } ] } }, "Environment": { "type": "object", "description": "Environment entity.", "properties": { "properties": { "$ref": "#/definitions/EnvironmentProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "EnvironmentKind": { "type": "string", "description": "The kind of environment", "enum": [ "development", "testing", "staging", "production" ], "x-ms-enum": { "name": "EnvironmentKind", "modelAsString": true, "values": [ { "name": "development", "value": "development", "description": "Development environment" }, { "name": "testing", "value": "testing", "description": "Testing environment" }, { "name": "staging", "value": "staging", "description": "Staging environment" }, { "name": "production", "value": "production", "description": "Production environment" } ] } }, "EnvironmentListResult": { "type": "object", "description": "The response of a Environment list operation.", "properties": { "value": { "type": "array", "description": "The Environment items on this page", "items": { "$ref": "#/definitions/Environment" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "EnvironmentProperties": { "type": "object", "description": "Environment properties entity.", "properties": { "title": { "type": "string", "description": "Environment title.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "The environment description." }, "kind": { "$ref": "#/definitions/EnvironmentKind", "description": "Environment kind." }, "server": { "$ref": "#/definitions/EnvironmentServer", "description": "Server information of the environment." }, "onboarding": { "$ref": "#/definitions/Onboarding", "description": "Environment onboarding information" }, "customProperties": { "$ref": "#/definitions/CustomProperties", "description": "The custom metadata defined for API catalog entities." } }, "required": [ "title", "kind" ] }, "EnvironmentServer": { "type": "object", "description": "Server information of the environment.", "properties": { "type": { "$ref": "#/definitions/EnvironmentServerType", "description": "Type of the server that represents the environment." }, "managementPortalUri": { "type": "array", "description": "The location of the management portal", "maxItems": 1, "items": { "type": "string" } } } }, "EnvironmentServerType": { "type": "string", "description": "The type of environment server", "enum": [ "Azure API Management", "Azure compute service", "Apigee API Management", "AWS API Gateway", "Kong API Gateway", "Kubernetes", "MuleSoft API Management" ], "x-ms-enum": { "name": "EnvironmentServerType", "modelAsString": true, "values": [ { "name": "Azure API Management", "value": "Azure API Management", "description": "Api Management Server" }, { "name": "Azure compute service", "value": "Azure compute service", "description": "Compute server" }, { "name": "Apigee API Management", "value": "Apigee API Management", "description": "Apigee server" }, { "name": "AWS API Gateway", "value": "AWS API Gateway", "description": "AWS Api Gateway server" }, { "name": "Kong API Gateway", "value": "Kong API Gateway", "description": "Kong API Gateway server" }, { "name": "Kubernetes", "value": "Kubernetes", "description": "Kubernetes server" }, { "name": "MuleSoft API Management", "value": "MuleSoft API Management", "description": "Mulesoft Api Management server" } ] } }, "ExternalDocumentation": { "type": "object", "description": "Additional, external documentation for the API.", "properties": { "title": { "type": "string", "description": "Title of the documentation.", "maxLength": 50 }, "description": { "type": "string", "description": "Description of the documentation.", "maxLength": 500 }, "url": { "type": "string", "format": "uri", "description": "URL pointing to the documentation.", "maxLength": 200 } }, "required": [ "url" ] }, "License": { "type": "object", "description": "The license information for the API.", "properties": { "name": { "type": "string", "description": "Name of the license.", "maxLength": 100 }, "url": { "type": "string", "format": "uri", "description": "URL pointing to the license details. The URL field is mutually exclusive of the\nidentifier field.", "maxLength": 200 }, "identifier": { "type": "string", "format": "uri", "description": "SPDX license information for the API. The identifier field is mutually\nexclusive of the URL field.", "maxLength": 50 } } }, "LifecycleStage": { "type": "string", "description": "The stage of the Api development lifecycle", "enum": [ "design", "development", "testing", "preview", "production", "deprecated", "retired" ], "x-ms-enum": { "name": "LifecycleStage", "modelAsString": true, "values": [ { "name": "design", "value": "design", "description": "design stage" }, { "name": "development", "value": "development", "description": "development stage" }, { "name": "testing", "value": "testing", "description": "testing stage" }, { "name": "preview", "value": "preview", "description": "In preview" }, { "name": "production", "value": "production", "description": "In production" }, { "name": "deprecated", "value": "deprecated", "description": "deprecated stage" }, { "name": "retired", "value": "retired", "description": "Retired stage" } ] } }, "ManagedServiceIdentityType": { "type": "string", "description": "The type of managed service identity", "enum": [ "None", "SystemAssigned", "UserAssigned", "SystemAssigned,UserAssigned" ], "x-ms-enum": { "name": "ManagedServiceIdentityType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "No identity" }, { "name": "SystemAssigned", "value": "SystemAssigned", "description": "Assigned by the system" }, { "name": "UserAssigned", "value": "UserAssigned", "description": "assigned by the user" }, { "name": "SystemAssigned,UserAssigned", "value": "SystemAssigned,UserAssigned", "description": "Both system-assigned and user-assigned identities" } ] } }, "MetadataAssignment": { "type": "object", "description": "Assignment metadata", "properties": { "entity": { "$ref": "#/definitions/MetadataAssignmentEntity", "description": "The entities this metadata schema component gets applied to." }, "required": { "type": "boolean", "description": "Required assignment" }, "deprecated": { "type": "boolean", "description": "Deprecated assignment" } } }, "MetadataAssignmentEntity": { "type": "string", "description": "Assignment entity for Metadata", "enum": [ "api", "environment", "deployment" ], "x-ms-enum": { "name": "MetadataAssignmentEntity", "modelAsString": true, "values": [ { "name": "api", "value": "api", "description": "Assigned to API" }, { "name": "environment", "value": "environment", "description": "Assigned to Environment" }, { "name": "deployment", "value": "deployment", "description": "Assigned to Deployment" } ] } }, "MetadataSchema": { "type": "object", "description": "Metadata schema entity. Used to define metadata for the entities in API catalog.", "properties": { "properties": { "$ref": "#/definitions/MetadataSchemaProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "MetadataSchemaExportFormat": { "type": "string", "description": "The format for schema export", "enum": [ "inline", "link" ], "x-ms-enum": { "name": "MetadataSchemaExportFormat", "modelAsString": true, "values": [ { "name": "inline", "value": "inline", "description": "The inlined content of a schema document." }, { "name": "link", "value": "link", "description": "The link to a schema document. The URL is valid for 5 minutes." } ] } }, "MetadataSchemaExportRequest": { "type": "object", "description": "The metadata schema export request.", "properties": { "assignedTo": { "$ref": "#/definitions/MetadataAssignmentEntity", "description": "An entity the metadata schema is requested for." } } }, "MetadataSchemaExportResult": { "type": "object", "description": "The metadata schema export result.", "properties": { "format": { "$ref": "#/definitions/MetadataSchemaExportFormat", "description": "The export format for the schema" }, "value": { "type": "string", "description": "The result of the export operation." } } }, "MetadataSchemaListResult": { "type": "object", "description": "The response of a MetadataSchema list operation.", "properties": { "value": { "type": "array", "description": "The MetadataSchema items on this page", "items": { "$ref": "#/definitions/MetadataSchema" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "MetadataSchemaProperties": { "type": "object", "description": "Metadata schema properties.", "properties": { "schema": { "type": "string", "description": "The schema defining the type." }, "assignedTo": { "type": "array", "description": "The assignees", "items": { "$ref": "#/definitions/MetadataAssignment" }, "x-ms-identifiers": [] } }, "required": [ "schema" ] }, "Onboarding": { "type": "object", "description": "Onboarding information", "properties": { "instructions": { "type": "string", "description": "Onboarding guide." }, "developerPortalUri": { "type": "array", "description": "The location of the development portal", "maxItems": 1, "items": { "type": "string" } } } }, "Origin": { "type": "string", "description": "The expected types of origin", "enum": [ "user", "system", "user,system" ], "x-ms-enum": { "name": "Origin", "modelAsString": true, "values": [ { "name": "user", "value": "user", "description": "Origin with User" }, { "name": "system", "value": "system", "description": "Origin with System" }, { "name": "user,system", "value": "user,system", "description": "Origin with user and system" } ] } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of the resource", "enum": [ "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." } ] }, "readOnly": true }, "Service": { "type": "object", "description": "The service entity.", "properties": { "properties": { "$ref": "#/definitions/ServiceProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "ServiceListResult": { "type": "object", "description": "The response of a Service list operation.", "properties": { "value": { "type": "array", "description": "The Service items on this page", "items": { "$ref": "#/definitions/Service" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "ServiceProperties": { "type": "object", "description": "The properties of the service.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the service.", "readOnly": true } } }, "ServiceUpdate": { "type": "object", "description": "The type used for update operations of the Service.", "properties": { "identity": { "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "SmallString": { "type": "string", "format": "uri", "description": "Used for restricted length uris", "maxLength": 200 }, "TermsOfService": { "type": "object", "description": "Terms of service for the API.", "properties": { "url": { "type": "string", "format": "uri", "description": "URL pointing to the terms of service.", "maxLength": 200 } }, "required": [ "url" ] }, "Workspace": { "type": "object", "description": "Workspace entity.", "properties": { "properties": { "$ref": "#/definitions/WorkspaceProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "WorkspaceListResult": { "type": "object", "description": "The response of a Workspace list operation.", "properties": { "value": { "type": "array", "description": "The Workspace items on this page", "items": { "$ref": "#/definitions/Workspace" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items", "readOnly": true } }, "required": [ "value" ] }, "WorkspaceProperties": { "type": "object", "description": "Workspace properties.", "properties": { "title": { "type": "string", "description": "Workspace title.", "minLength": 1, "maxLength": 50 }, "description": { "type": "string", "description": "Workspace description." } }, "required": [ "title" ] } }, "parameters": { "OdataFilterParameter": { "name": "$filter", "in": "query", "description": "OData filter parameter.", "required": false, "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "filter" } } }