From 574374c39c0aee9aa3e25d002eb0872697085b48 Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Thu, 11 Jan 2018 12:03:39 -0800 Subject: [PATCH 01/10] APIM tags documentation --- .../stable/2017-03-01/apimapis.json | 1111 +++++++++++++++-- .../stable/2017-03-01/apimapisbytags.json | 94 ++ .../stable/2017-03-01/apimgroups.json | 2 +- .../stable/2017-03-01/apimproducts.json | 275 ++++ .../stable/2017-03-01/apimtagresources.json | 186 +++ .../stable/2017-03-01/apimtags.json | 547 ++++++++ .../examples/ApiManagementCreateApiTag.json | 32 + .../ApiManagementCreateApiTagDescription.json | 38 + .../ApiManagementCreateOperationTag.json | 33 + .../ApiManagementCreateProductTag.json | 32 + .../examples/ApiManagementCreateTag.json | 36 + .../examples/ApiManagementDeleteApiTag.json | 14 + .../ApiManagementDeleteApiTagDescription.json | 14 + .../ApiManagementDeleteOperationTag.json | 15 + .../ApiManagementDeleteProductTag.json | 14 + .../examples/ApiManagementDeleteTag.json | 13 + .../examples/ApiManagementGetApiTag.json | 22 + .../ApiManagementGetApiTagDescription.json | 25 + .../ApiManagementGetOperationTag.json | 23 + .../examples/ApiManagementGetProductTag.json | 22 + .../examples/ApiManagementGetTag.json | 21 + ...ApiManagementGetTagDescriptionsForApi.json | 29 + .../examples/ApiManagementGetTagsForApi.json | 26 + .../ApiManagementGetTagsForOperation.json | 27 + .../ApiManagementGetTagsForProduct.json | 26 + .../examples/ApiManagementHeadApiTag.json | 17 + .../ApiManagementHeadApiTagDescription.json | 17 + .../ApiManagementHeadOperationTag.json | 18 + .../examples/ApiManagementHeadProductTag.json | 17 + .../examples/ApiManagementHeadTag.json | 16 + .../examples/ApiManagementListApisByTags.json | 71 ++ .../ApiManagementListOperationsByTags.json | 50 + .../ApiManagementListTagResources.json | 67 + .../examples/ApiManagementListTags.json | 33 + .../examples/ApiManagementUpdateTag.json | 18 + 35 files changed, 2896 insertions(+), 105 deletions(-) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagDescriptionsForApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForApi.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForOperation.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForProduct.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTagDescription.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadOperationTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadTag.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTags.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementUpdateTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json index d4ab729c1174..d863722ad99e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json @@ -851,16 +851,873 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { + "get": { + "tags": [ + "OperationTags" + ], + "operationId": "Tags_ListByOperation", + "description": "Lists all Tags associated with the Operation.", + "x-ms-examples": { + "ApiManagementGetTagsForOperation": { + "$ref": "./examples/ApiManagementGetTagsForOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Operation entity.", + "schema": { + "$ref": "./apimtags.json#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtags.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { + "head": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_HeadByOperation", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadOperationTag": { + "$ref": "./examples/ApiManagementHeadOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_GetByOperation", + "description": "Get tag associated with the Operation.", + "x-ms-examples": { + "ApiManagementGetOperationTag": { + "$ref": "./examples/ApiManagementGetOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "#./apimtags.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OperationTags" + ], + "operationId": "OperationTag_CreateOrUpdate", + "description": "Assign tag to the Operation.", + "x-ms-examples": { + "ApiManagementCreateOperationTag": { + "$ref": "./examples/ApiManagementCreateOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Operation.", + "schema": { + "$ref": "#./apimtags.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Operation.", + "schema": { + "$ref": "#./apimtags.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OperationTags" + ], + "operationId": "OperationTag_Delete", + "description": "Detach the tag from the Operation.", + "x-ms-examples": { + "ApiManagementDeleteOperationTag": { + "$ref": "./examples/ApiManagementDeleteOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Successfully detached the tag from the Operation." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { + "get": { + "tags": [ + "OperationsByTags" + ], + "operationId": "OperationsByTags_List", + "description": "Lists a collection of operations associated with tags.", + "x-ms-examples": { + "ApiManagementListOperationsByTags": { + "$ref": "./examples/ApiManagementListOperationsByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { "get": { "tags": [ - "ApiProduct" + "ApiProduct" + ], + "operationId": "ApiProduct_ListByApis", + "description": "Lists all Products, which the API is part of.", + "x-ms-examples": { + "ApiManagementGetProductsForApi": { + "$ref": "./examples/ApiManagementGetProductsForApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of products which have the Api entity.", + "schema": { + "$ref": "./apimproducts.json#/definitions/ProductCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimproducts.json#/definitions/ProductContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_ListByApi", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementListApiPolicies": { + "$ref": "./examples/ApiManagementListApiPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Policy Collection.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyCollection" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_Get", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetApiPolicy": { + "$ref": "./examples/ApiManagementGetApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Policy information.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateApiPolicy": { + "$ref": "./examples/ApiManagementCreateApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "required": true, + "description": "The policy contents to apply." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api Policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api policy configuration was successfully created.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "200": { + "description": "Api policy configuration of the tenant was successfully updated.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_Delete", + "description": "Deletes the policy configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiPolicy": { + "$ref": "./examples/ApiManagementDeleteApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Successfully deleted the policy configuration at the API level." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_ListByApi", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementListApiSchemas": { + "$ref": "./examples/ApiManagementListApiSchemas.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Apis Schema Collection.", + "schema": { + "$ref": "#/definitions/SchemaCollection" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + "get": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_Get", + "description": "Get the schema configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetApiSchema": { + "$ref": "./examples/ApiManagementGetApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/SchemaIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Api Schema information.", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_CreateOrUpdate", + "description": "Creates or updates schema configuration for the API.", + "x-ms-examples": { + "ApiManagementCreateApiSchema": { + "$ref": "./examples/ApiManagementCreateApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/SchemaIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/SchemaContract" + }, + "required": true, + "description": "The schema contents to apply." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "The entity state (Etag) version of the Api Schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Api schema configuration was successfully created.", + "schema": { + "$ref": "#/definitions/SchemaContract" + } + }, + "200": { + "description": "Api schema configuration of the tenant was successfully updated.", + "schema": { + "$ref": "#/definitions/SchemaContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiSchema" + ], + "operationId": "ApiSchema_Delete", + "description": "Deletes the schema configuration at the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiSchema": { + "$ref": "./examples/ApiManagementDeleteApiSchema.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/SchemaIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Successfully deleted the schema configuration at the API level." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { + "get": { + "tags": [ + "ApiTags" ], - "operationId": "ApiProduct_ListByApis", - "description": "Lists all Products, which the API is part of.", + "operationId": "Tags_ListByApi", + "description": "Lists all Tags associated with the API.", "x-ms-examples": { - "ApiManagementGetProductsForApi": { - "$ref": "./examples/ApiManagementGetProductsForApi.json" + "ApiManagementGetTagsForApi": { + "$ref": "./examples/ApiManagementGetTagsForApi.json" } }, "parameters": [ @@ -878,7 +1735,7 @@ "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -895,9 +1752,9 @@ ], "responses": { "200": { - "description": "The operation returns a collection of products which have the Api entity.", + "description": "The operation returns a collection of tags associated with the Api entity.", "schema": { - "$ref": "./apimproducts.json#/definitions/ProductCollection" + "$ref": "./apimtags.json#/definitions/TagCollection" } }, "default": { @@ -910,19 +1767,19 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimproducts.json#/definitions/ProductContract" + "x-ms-odata": "./apimtags.json#/definitions/TagContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { + "head": { "tags": [ - "ApiPolicy" + "ApiTags" ], - "operationId": "ApiPolicy_ListByApi", - "description": "Get the policy configuration at the API level.", + "operationId": "Tag_HeadByApi", + "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { - "ApiManagementListApiPolicies": { - "$ref": "./examples/ApiManagementListApiPolicies.json" + "ApiManagementHeadApiTag": { + "$ref": "./examples/ApiManagementHeadApiTag.json" } }, "parameters": [ @@ -935,6 +1792,9 @@ { "$ref": "#/parameters/ApiIdParameter" }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -944,10 +1804,7 @@ ], "responses": { "200": { - "description": "Apis Policy Collection.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyCollection" - }, + "description": "Empty response body, ETag header entity state version.", "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -962,18 +1819,16 @@ } } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { + }, "get": { "tags": [ - "ApiPolicy" + "ApiTags" ], - "operationId": "ApiPolicy_Get", - "description": "Get the policy configuration at the API level.", + "operationId": "Tag_GetByApi", + "description": "Get tag associated with the API.", "x-ms-examples": { - "ApiManagementGetApiPolicy": { - "$ref": "./examples/ApiManagementGetApiPolicy.json" + "ApiManagementGetApiTag": { + "$ref": "./examples/ApiManagementGetApiTag.json" } }, "parameters": [ @@ -987,7 +1842,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "#./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -998,9 +1853,9 @@ ], "responses": { "200": { - "description": "Api Policy information.", + "description": "Gets the details of the tag specified by its identifier.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "#./apimtags.json#/definitions/TagContract" }, "headers": { "ETag": { @@ -1019,13 +1874,13 @@ }, "put": { "tags": [ - "ApiPolicy" + "ApiTags" ], - "operationId": "ApiPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the API.", + "operationId": "Tag_CreateOrUpdateForApi", + "description": "Assign tag to the Api.", "x-ms-examples": { - "ApiManagementCreateApiPolicy": { - "$ref": "./examples/ApiManagementCreateApiPolicy.json" + "ApiManagementCreateApiTag": { + "$ref": "./examples/ApiManagementCreateApiTag.json" } }, "parameters": [ @@ -1039,22 +1894,13 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - }, - "required": true, - "description": "The policy contents to apply." + "$ref": "#./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", "in": "header", - "required": true, - "description": "The entity state (Etag) version of the Api Policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "required": false, + "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", "type": "string" }, { @@ -1066,15 +1912,15 @@ ], "responses": { "201": { - "description": "Api policy configuration was successfully created.", + "description": "Tag was assigned to the Api.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "#./apimtags.json#/definitions/TagContract" } }, "200": { - "description": "Api policy configuration of the tenant was successfully updated.", + "description": "Tag is already assigned to the Api.", "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" + "$ref": "#./apimtags.json#/definitions/TagContract" } }, "default": { @@ -1087,13 +1933,13 @@ }, "delete": { "tags": [ - "ApiPolicy" + "ApiTags" ], - "operationId": "ApiPolicy_Delete", - "description": "Deletes the policy configuration at the Api.", + "operationId": "Tag_DeleteFromApi", + "description": "Detach the tag from the Api.", "x-ms-examples": { - "ApiManagementDeleteApiPolicy": { - "$ref": "./examples/ApiManagementDeleteApiPolicy.json" + "ApiManagementDeleteApiTag": { + "$ref": "./examples/ApiManagementDeleteApiTag.json" } }, "parameters": [ @@ -1107,13 +1953,13 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + "$ref": "#./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", "in": "header", "required": true, - "description": "The entity state (Etag) version of the Api policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", "type": "string" }, { @@ -1125,7 +1971,7 @@ ], "responses": { "204": { - "description": "Successfully deleted the policy configuration at the API level." + "description": "Successfully detached the tag from the Api." }, "default": { "description": "Error response describing why the operation failed.", @@ -1136,16 +1982,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { "get": { "tags": [ - "ApiSchema" + "ApiTagDescriptions" ], - "operationId": "ApiSchema_ListByApi", - "description": "Get the schema configuration at the API level.", + "operationId": "TagDescriptions_ListByApi", + "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", "x-ms-examples": { - "ApiManagementListApiSchemas": { - "$ref": "./examples/ApiManagementListApiSchemas.json" + "ApiManagementGetTagDescriptionsForApi": { + "$ref": "./examples/ApiManagementGetTagDescriptionsForApi.json" } }, "parameters": [ @@ -1158,6 +2004,19 @@ { "$ref": "#/parameters/ApiIdParameter" }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -1167,10 +2026,59 @@ ], "responses": { "200": { - "description": "Apis Schema Collection.", + "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", "schema": { - "$ref": "#/definitions/SchemaCollection" - }, + "$ref": "./apimtags.json#/definitions/TagDescriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtags.json#/definitions/TagDescriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagId}": { + "head": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_HeadByApi", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTagDescription": { + "$ref": "./examples/ApiManagementHeadApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -1184,22 +2092,17 @@ "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + }, "get": { "tags": [ - "ApiSchema" + "ApiTagDescriptions" ], - "operationId": "ApiSchema_Get", - "description": "Get the schema configuration at the API level.", + "operationId": "TagDescription_GetByApi", + "description": "Get tag associated with the API.", "x-ms-examples": { - "ApiManagementGetApiSchema": { - "$ref": "./examples/ApiManagementGetApiSchema.json" + "ApiManagementGetApiTagDescription": { + "$ref": "./examples/ApiManagementGetApiTagDescription.json" } }, "parameters": [ @@ -1213,7 +2116,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/SchemaIdParameter" + "$ref": "#./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1224,9 +2127,9 @@ ], "responses": { "200": { - "description": "Api Schema information.", + "description": "Gets the description of the tag specified by its identifier in scope if the Api.", "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "#./apimtags.json#/definitions/TagDescriptionContract" }, "headers": { "ETag": { @@ -1245,13 +2148,13 @@ }, "put": { "tags": [ - "ApiSchema" + "ApiTagDescriptions" ], - "operationId": "ApiSchema_CreateOrUpdate", - "description": "Creates or updates schema configuration for the API.", + "operationId": "TagDescription_CreateOrUpdateForApi", + "description": "Create/Update tag fescription in scope of the Api.", "x-ms-examples": { - "ApiManagementCreateApiSchema": { - "$ref": "./examples/ApiManagementCreateApiSchema.json" + "ApiManagementCreateApiTagDescription": { + "$ref": "./examples/ApiManagementCreateApiTagDescription.json" } }, "parameters": [ @@ -1265,22 +2168,22 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/SchemaIdParameter" + "$ref": "#./apimtags.json#/parameters/TagIdParameter" }, { "name": "parameters", "in": "body", + "required": true, "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "#./apimtags.json/definitions/TagDescriptionCreateParameters" }, - "required": true, - "description": "The schema contents to apply." + "description": "Create parameters." }, { "name": "If-Match", "in": "header", "required": false, - "description": "The entity state (Etag) version of the Api Schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", "type": "string" }, { @@ -1292,15 +2195,15 @@ ], "responses": { "201": { - "description": "Api schema configuration was successfully created.", + "description": "Tag Description was created for the Api.", "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "#./apimtags.json#/definitions/TagDescriptionContract" } }, "200": { - "description": "Api schema configuration of the tenant was successfully updated.", + "description": "Tag Description was updated for the Api.", "schema": { - "$ref": "#/definitions/SchemaContract" + "$ref": "#./apimtags.json#/definitions/TagDescriptionContract" } }, "default": { @@ -1313,13 +2216,13 @@ }, "delete": { "tags": [ - "ApiSchema" + "ApiTagDescriptions" ], - "operationId": "ApiSchema_Delete", - "description": "Deletes the schema configuration at the Api.", + "operationId": "TagDescription_DeleteFromApi", + "description": "Delete tag description for the Api.", "x-ms-examples": { - "ApiManagementDeleteApiSchema": { - "$ref": "./examples/ApiManagementDeleteApiSchema.json" + "ApiManagementDeleteApiTagDescription": { + "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" } }, "parameters": [ @@ -1333,7 +2236,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/SchemaIdParameter" + "$ref": "#./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", @@ -1351,7 +2254,7 @@ ], "responses": { "204": { - "description": "Successfully deleted the schema configuration at the API level." + "description": "Successfully deleted tag description for the Api." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json new file mode 100644 index 000000000000..b68826998e9c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json @@ -0,0 +1,94 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for grouping APIs by tags.", + "version": "2017-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags": { + "get": { + "tags": [ + "ApisByTags" + ], + "operationId": "ApisByTags_ListByService", + "description": "Lists a collection of apis associated with tags.", + "x-ms-examples": { + "ApiManagementListApisByTags": { + "$ref": "./examples/ApiManagementListApisByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| isCurrent | eq | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" + } + } + }, + "definitions": { + }, + "parameters": { + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json index 16f33e071dc0..04e64fff6993 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json @@ -536,7 +536,7 @@ "required": [ "displayName" ], - "description": "Developer group." + "description": "Group contract Properties." }, "GroupCreateParameters": { "properties": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json index c9e9f6b431ba..7e6bfcadfe40 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json @@ -914,7 +914,282 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags": { + "get": { + "tags": [ + "ProductTags" + ], + "operationId": "Tags_ListByProduct", + "description": "Lists all Tags associated with the Product.", + "x-ms-examples": { + "ApiManagementGetTagsForProduct": { + "$ref": "./examples/ApiManagementGetTagsForProduct.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Product entity.", + "schema": { + "$ref": "./apimtags.json#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtags.json#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": { + "head": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_HeadByProduct", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadProductTag": { + "$ref": "./examples/ApiManagementHeadProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_GetByProduct", + "description": "Get tag associated with the Product.", + "x-ms-examples": { + "ApiManagementGetProductTag": { + "$ref": "./examples/ApiManagementGetProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "#./apimtags.json#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_CreateOrUpdateForProduct", + "description": "Assign tag to the Product.", + "x-ms-examples": { + "ApiManagementCreateProductTag": { + "$ref": "./examples/ApiManagementCreateProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Product.", + "schema": { + "$ref": "#./apimtags.json#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Product.", + "schema": { + "$ref": "#./apimtags.json#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ProductTags" + ], + "operationId": "Tag_DeleteFromProduct", + "description": "Detach the tag from the Product.", + "x-ms-examples": { + "ApiManagementDeleteProductTag": { + "$ref": "./examples/ApiManagementDeleteProductTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ProductIdParameter" + }, + { + "$ref": "#./apimtags.json#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Successfully detached the tag from the Product." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } } + }, "definitions": { "ProductCollection": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json new file mode 100644 index 000000000000..d6e474b21401 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json @@ -0,0 +1,186 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for queuering APIs. Operations and Products by tags in your Azure API Management deployment.", + "version": "2017-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tagResources": { + "get": { + "tags": [ + "TagResources" + ], + "operationId": "TagResources_ListByService", + "description": "Lists a collection of resources associated with tags.", + "x-ms-examples": { + "ApiManagementListTagResources": { + "$ref": "./examples/ApiManagementListTagResources.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| aid | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| state | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| isCurrent | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "#/definitions/TagResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagResourceContract" + } + } + }, + "definitions": { + "TagResourceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagResourceContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag list representation." + }, + "TagResourceContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagResourceContractProperties", + "description": "TagResource entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Contract details." + }, + "TagResourceContractProperties": { + "properties": { + "tag": { + "$ref": "./apimtags.json#/definitions/TagContract", + "description": "Tag associated with the resource." + }, + "api": { + "$ref": "./apimapis.json#/definitions/ApiContract", + "description": "Api associated with the tag." + }, + "operation": { + "$ref": "#/definitions/OperationEntityContract", + "description": "Api associated with the tag." + }, + "product": { + "$ref": "./apimproducts.json#/definitions/ProductContract", + "description": "Product associated with the tag." + } + }, + "description": "TagResource contract properties." + }, + "OperationEntityContract": { + "properties": { + "displayName": { + "type": "string", + "description": "Operation name." + }, + "apiName": { + "type": "string", + "description": "Api Name." + }, + "apiRevision": { + "type": "string", + "description": "Api Revision." + }, + "apiVersion": { + "type": "string", + "description": "Api Version." + }, + "description": { + "type": "string", + "description": "Operation Description." + }, + "method": { + "type": "string", + "description": "A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.", + "externalDocs": { + "description": "As defined by RFC.", + "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" + } + }, + "urlTemplate": { + "type": "string", + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}" + } + }, + "required": [ + "displayName" + ], + "description": "Operation Entity Contract Properties." + } + }, + "parameters": { + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json new file mode 100644 index 000000000000..83bdaa1a79c9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json @@ -0,0 +1,547 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs for performing operations on Tag entity in your Azure API Management deployment. Tags can be assigned to APIs, Operations and Products.", + "version": "2017-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_ListByService", + "description": "Lists a collection of tags defined within a service instance.", + "x-ms-examples": { + "ApiManagementListTags": { + "$ref": "./examples/ApiManagementListTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of Tag entities.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags/{tagId}": { + "head": { + "tags": [ + "Tags" + ], + "operationId": "Tag_Head", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetTag": { + "$ref": "./examples/ApiManagementHeadTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tag_Get", + "description": "Gets the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementGetTag": { + "$ref": "./examples/ApiManagementGetTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The response body contains the specified Tag entity.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tag_CreateOrUpdate", + "description": "Creates or Updates a tag.", + "x-ms-examples": { + "ApiManagementCreateTag": { + "$ref": "./examples/ApiManagementCreateTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagCreateParameters" + }, + "description": "Create parameters." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was created succesfully.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "200": { + "description": "Tag already exists.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Tags" + ], + "operationId": "Tag_Update", + "description": "Updates the details of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementUpdateTag": { + "$ref": "./examples/ApiManagementUpdateTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagUpdateParameters" + }, + "description": "Update parameters." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Tag Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The tag details were successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tag_Delete", + "description": "Deletes specific tag of the API Management service instance.", + "x-ms-examples": { + "ApiManagementDeleteTag": { + "$ref": "./examples/ApiManagementDeleteTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "ETag of the Tag Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The tag was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "TagCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged Tag list representation." + }, + "TagContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagContractProperties", + "description": "Tag entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Contract details." + }, + "TagContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "required": [ + "displayName" + ], + "description": "Tag contract Properties." + }, + "TagCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagCreateParametersProperties", + "description": "Properties supplied to Create Tag operation." + } + }, + "description": "Parameters supplied to the Create Tag operation." + }, + "TagCreateParametersProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "required": [ + "displayName" + ], + "description": "Parameters supplied to the Create Tag operation." + }, + "TagUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagUpdateParametersProperties", + "description": "Tag entity update contract properties." + } + }, + "description": "Parameters supplied to the Update Tag operation." + }, + "TagUpdateParametersProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + } + }, + "description": "Parameters supplied to the Update Tag operation." + }, + "TagDescriptionCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "description": "Page values." + }, + "nextLink": { + "type": "string", + "description": "Next page link if any." + } + }, + "description": "Paged TagDescription list representation." + }, + "TagDescriptionContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagDescriptionContractProperties", + "description": "TagDescription entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Contract details." + }, + "TagDescriptionContractProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Description of the Tag." + }, + "externalDocsUrl": { + "type": "string", + "description": "Absolute URL of external resources describing the tag." + }, + "externalDocsDescription": { + "type": "string", + "description": "Description of the external resources describing the tag." + } + }, + "required": [ + "displayName" + ], + "description": "TagDescription contract Properties." + }, + "TagDescriptionCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TagDescriptionCreateParametersProperties", + "description": "Properties supplied to Create TagDescription operation." + } + }, + "description": "Parameters supplied to the Create TagDescription operation." + }, + "TagDescriptionCreateParametersProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "Tag name.", + "maxLength": 160, + "minLength": 1 + }, + "description": { + "type": "string", + "description": "Description of the Tag." + }, + "externalDocsUrl": { + "type": "string", + "description": "Absolute URL of external resources describing the tag." + }, + "externalDocsDescription": { + "type": "string", + "description": "Description of the external resources describing the tag." + } + }, + "required": [ + "displayName" + ], + "description": "Parameters supplied to the Create TagDescription operation." + } + }, + "parameters": { + "TagIdParameter": { + "name": "tagId", + "in": "path", + "required": true, + "type": "string", + "description": "Tag identifier. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTag.json new file mode 100644 index 000000000000..4d8e0343241d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTag.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json new file mode 100644 index 000000000000..d0c9e049b4e8 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateOperationTag.json new file mode 100644 index 000000000000..672e3774f58c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateOperationTag.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "5931a75ae4bbd512a88c680b", + "operationId": "5931a75ae4bbd512a88c680a", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateProductTag.json new file mode 100644 index 000000000000..675c7f6b7c16 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateProductTag.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "productId": "5931a75ae4bbd512a88c680b", + "tagId": "tagId1" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateTag.json new file mode 100644 index 000000000000..840a4a655512 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateTag.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "tagId": "tagId1", + "parameters": { + "properties": { + "displayName": "tag1" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1", + "type": "Microsoft.ApiManagement/service/tags", + "name": "tagId1", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTag.json new file mode 100644 index 000000000000..a1325e35cc65 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTag.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTagDescription.json new file mode 100644 index 000000000000..a1325e35cc65 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteApiTagDescription.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteOperationTag.json new file mode 100644 index 000000000000..387c69dec790 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteOperationTag.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d5b28d1f7fab116c282650", + "operationId": "59d5b28d1f7fab116c282651", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProductTag.json new file mode 100644 index 000000000000..ef8fe4c18062 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProductTag.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "productId": "59d5b28d1f7fab116c282650", + "tagId": "59d5b28e1f7fab116402044e", + "If-Match": "*" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteTag.json new file mode 100644 index 000000000000..e7dc93aa5572 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteTag.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "tagId": "tagId1", + "If-Match": "*" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTag.json new file mode 100644 index 000000000000..d848a359e959 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTagDescription.json new file mode 100644 index 000000000000..f1c4dcea328e --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetApiTagDescription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetOperationTag.json new file mode 100644 index 000000000000..10dea824df51 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetOperationTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetProductTag.json new file mode 100644 index 000000000000..31b38d38475a --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetProductTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "productId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTag.json new file mode 100644 index 000000000000..e996a2b50ef9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTag.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9", + "type": "Microsoft.ApiManagement/service/tags", + "name": "59306a29e4bbd510dc24e5f9", + "properties": { + "displayName": "tag1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagDescriptionsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagDescriptionsForApi.json new file mode 100644 index 000000000000..21c457cd89e5 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagDescriptionsForApi.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1", + "description": null, + "externalDocsDescription": "some additional info", + "externalDocsUrl": "http://some_url.com" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForApi.json new file mode 100644 index 000000000000..bf01a40320be --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForApi.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForOperation.json new file mode 100644 index 000000000000..11f36ef3aab1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForOperation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "57d2ef278aa04f0888cba3f3", + "operationId": "57d2ef278aa04f0888cba3f6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForProduct.json new file mode 100644 index 000000000000..0bed111f55ca --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetTagsForProduct.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "productId": "57d2ef278aa04f0888cba3f1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b539c53f5b0062060002", + "properties": { + "displayName": "tag1" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTag.json new file mode 100644 index 000000000000..e1783f4b1260 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTagDescription.json new file mode 100644 index 000000000000..e1783f4b1260 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadApiTagDescription.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadOperationTag.json new file mode 100644 index 000000000000..cbfd8d40ef65 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadOperationTag.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59d6bb8f1f7fab13dc67ec9b", + "operationId": "59d6bb8f1f7fab13dc67ec9a", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json new file mode 100644 index 000000000000..82d9b327036d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "59306a29e4bbd510dc24e5f8", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadTag.json new file mode 100644 index 000000000000..6b643a6fb5e1 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadTag.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "tagId": "59306a29e4bbd510dc24e5f9" + }, + "responses": { + "200": { + "headers": { + "Etag": "AAAAAAAACCI=" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json new file mode 100644 index 000000000000..e29b6022b008 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/t1", + "name": "tag1" + }, + "api": { + "id": "/apis/a1", + "name": "api1", + "apiRevision": "1", + "description": null, + "serviceUrl": "", + "path": "api1", + "protocols": null, + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true + } + }, + { + "tag": { + "id": "/tags/t1", + "name": "tag1" + }, + "api": { + "id": "/apis/a2", + "name": "api2", + "apiRevision": "1", + "description": null, + "serviceUrl": "", + "path": "api2", + "protocols": null, + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true + } + }, + { + "tag": { + "id": "/tags/t2", + "name": "tag2" + }, + "api": { + "id": "/apis/a2", + "name": "api2", + "apiRevision": "1", + "description": null, + "serviceUrl": "", + "path": "api2", + "protocols": null, + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json new file mode 100644 index 000000000000..f9b81570aca9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "apiId": "a1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/t1", + "name": "tag1" + }, + "operation": { + "id": "/apis/a1/operations/o2", + "apiName": "api1", + "apiRevision": "1", + "apiVersion": null, + "name": "api2", + "method": "GET", + "urlTemplate": "/op1", + "description": null + } + }, + { + "tag": { + "id": "/tags/t1", + "name": "tag1" + }, + "operation": { + "id": "/apis/a1/operations/o1", + "apiName": "api1", + "apiRevision": "1", + "apiVersion": null, + "name": "api22", + "method": "GET", + "urlTemplate": "/op2", + "description": null + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json new file mode 100644 index 000000000000..db97c916b23f --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tag": { + "id": "/tags/t1", + "name": "tag1" + }, + "operation": { + "id": "/apis/a1/operations/o2", + "apiName": "api1", + "apiRevision": "1", + "apiVersion": null, + "name": "api2", + "method": "GET", + "urlTemplate": "/op1", + "description": null + } + }, + { + "tag": { + "id": "/tags/t1", + "name": "tag1" + }, + "api": { + "id": "/apis/a1", + "name": "api1", + "apiRevision": "1", + "description": null, + "serviceUrl": "", + "path": "api1", + "protocols": null, + "authenticationSettings": null, + "subscriptionKeyParameterNames": null, + "isCurrent": true + } + }, + { + "tag": { + "id": "/tags/t1", + "name": "tag1" + }, + "product": { + "id": "/products/p1", + "name": "product1", + "description": null, + "terms": null, + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": null, + "state": "notPublished" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTags.json new file mode 100644 index 000000000000..99e0191f3024 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { + "displayName": "tag1" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020002", + "properties": { + "displayName": "tag2" + } + } + ], + "nextLink": "" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementUpdateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementUpdateTag.json new file mode 100644 index 000000000000..5b925d576bab --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementUpdateTag.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "tagId": "temptag", + "If-Match": "*", + "parameters": { + "properties": { + "displayName": "temp tag" + } + } + }, + "responses": { + "204": {} + } +} \ No newline at end of file From f5fab07f82d631099d7458b689bcb4113e2a4327 Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Thu, 11 Jan 2018 16:19:21 -0800 Subject: [PATCH 02/10] some small changes after code review --- .../stable/2017-03-01/apimtagresources.json | 24 ++++--- .../stable/2017-03-01/apimtags.json | 62 +++---------------- .../apimanagement/resource-manager/readme.md | 3 + 3 files changed, 26 insertions(+), 63 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json index d6e474b21401..80fb89538021 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json @@ -144,23 +144,28 @@ "properties": { "displayName": { "type": "string", - "description": "Operation name." + "description": "Operation name.", + "readOnly": true }, "apiName": { "type": "string", - "description": "Api Name." + "description": "Api Name.", + "readOnly": true }, "apiRevision": { "type": "string", - "description": "Api Revision." + "description": "Api Revision.", + "readOnly": true }, "apiVersion": { "type": "string", - "description": "Api Version." + "description": "Api Version.", + "readOnly": true }, "description": { "type": "string", - "description": "Operation Description." + "description": "Operation Description.", + "readOnly": true }, "method": { "type": "string", @@ -168,16 +173,15 @@ "externalDocs": { "description": "As defined by RFC.", "url": "http://www.rfc-editor.org/rfc/rfc7230.txt" - } + }, + "readOnly": true }, "urlTemplate": { "type": "string", - "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}" + "description": "Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}", + "readOnly": true } }, - "required": [ - "displayName" - ], "description": "Operation Entity Contract Properties." } }, diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json index 83bdaa1a79c9..7a09befdeaae 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json @@ -376,7 +376,7 @@ "$ref": "./apimanagement.json#/definitions/Resource" } ], - "description": "Contract details." + "description": "Tag Contract details." }, "TagContractProperties": { "properties": { @@ -396,47 +396,22 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/TagCreateParametersProperties", + "$ref": "#/definitions/TagContractProperties", "description": "Properties supplied to Create Tag operation." } }, "description": "Parameters supplied to the Create Tag operation." }, - "TagCreateParametersProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "Tag name.", - "maxLength": 160, - "minLength": 1 - } - }, - "required": [ - "displayName" - ], - "description": "Parameters supplied to the Create Tag operation." - }, "TagUpdateParameters": { "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/TagUpdateParametersProperties", + "$ref": "#/definitions/TagContractProperties", "description": "Tag entity update contract properties." } }, "description": "Parameters supplied to the Update Tag operation." }, - "TagUpdateParametersProperties": { - "properties": { - "displayName": { - "type": "string", - "description": "Tag name.", - "maxLength": 160, - "minLength": 1 - } - }, - "description": "Parameters supplied to the Update Tag operation." - }, "TagDescriptionCollection": { "properties": { "value": { @@ -475,22 +450,12 @@ "description": "Tag name.", "maxLength": 160, "minLength": 1 - }, - "description": { - "type": "string", - "description": "Description of the Tag." - }, - "externalDocsUrl": { - "type": "string", - "description": "Absolute URL of external resources describing the tag." - }, - "externalDocsDescription": { - "type": "string", - "description": "Description of the external resources describing the tag." } }, - "required": [ - "displayName" + "allOf": [ + { + "$ref": "#/definitions/TagDescriptionBaseProperties" + } ], "description": "TagDescription contract Properties." }, @@ -498,20 +463,14 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/TagDescriptionCreateParametersProperties", + "$ref": "#/definitions/TagDescriptionBaseProperties", "description": "Properties supplied to Create TagDescription operation." } }, "description": "Parameters supplied to the Create TagDescription operation." }, - "TagDescriptionCreateParametersProperties": { + "TagDescriptionBaseProperties": { "properties": { - "displayName": { - "type": "string", - "description": "Tag name.", - "maxLength": 160, - "minLength": 1 - }, "description": { "type": "string", "description": "Description of the Tag." @@ -525,9 +484,6 @@ "description": "Description of the external resources describing the tag." } }, - "required": [ - "displayName" - ], "description": "Parameters supplied to the Create TagDescription operation." } }, diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index e1cf7eca5ba7..1905b51ddf73 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -40,6 +40,7 @@ These settings apply only when `--tag=package-2017-03` is specified on the comma input-file: - Microsoft.ApiManagement/stable/2017-03-01/apimanagement.json - Microsoft.ApiManagement/stable/2017-03-01/apimapis.json +- Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json - Microsoft.ApiManagement/stable/2017-03-01/apimauthorizationservers.json - Microsoft.ApiManagement/stable/2017-03-01/apimbackends.json - Microsoft.ApiManagement/stable/2017-03-01/apimcertificates.json @@ -56,6 +57,8 @@ input-file: - Microsoft.ApiManagement/stable/2017-03-01/apimquotas.json - Microsoft.ApiManagement/stable/2017-03-01/apimreports.json - Microsoft.ApiManagement/stable/2017-03-01/apimsubscriptions.json +- Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json +- Microsoft.ApiManagement/stable/2017-03-01/apimtags.json - Microsoft.ApiManagement/stable/2017-03-01/apimtenant.json - Microsoft.ApiManagement/stable/2017-03-01/apimusers.json ``` From 58ff5cbffe6ff76678f4ac2a93e99ceb2c00f2bb Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Fri, 12 Jan 2018 16:22:18 -0800 Subject: [PATCH 03/10] some small changes and examples fixes after code review --- .../stable/2017-03-01/apimapis.json | 44 +++--- .../stable/2017-03-01/apimproducts.json | 20 ++- .../stable/2017-03-01/apimtagresources.json | 20 ++- .../stable/2017-03-01/apimtags.json | 21 +-- .../ApiManagementCreateApiTagDescription.json | 9 +- .../examples/ApiManagementDeleteProduct.json | 24 +-- .../examples/ApiManagementHeadProductTag.json | 2 +- .../examples/ApiManagementListApisByTags.json | 114 +++++++++------ .../ApiManagementListOperationsByTags.json | 70 +++++---- .../ApiManagementListTagResources.json | 138 ++++++++++++------ 10 files changed, 285 insertions(+), 177 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json index d863722ad99e..55d0462d0f63 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json @@ -942,7 +942,7 @@ "$ref": "#/parameters/OperationIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -994,7 +994,7 @@ "$ref": "#/parameters/OperationIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1007,7 +1007,7 @@ "200": { "description": "Gets the details of the tag specified by its identifier.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" }, "headers": { "ETag": { @@ -1049,7 +1049,7 @@ "$ref": "#/parameters/OperationIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", @@ -1069,13 +1069,13 @@ "201": { "description": "Tag was assigned to the Operation.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" } }, "200": { "description": "Tag is already assigned to the Operation.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" } }, "default": { @@ -1111,7 +1111,7 @@ "$ref": "#/parameters/OperationIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", @@ -1793,7 +1793,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1842,7 +1842,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1855,7 +1855,7 @@ "200": { "description": "Gets the details of the tag specified by its identifier.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" }, "headers": { "ETag": { @@ -1894,7 +1894,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", @@ -1914,13 +1914,13 @@ "201": { "description": "Tag was assigned to the Api.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" } }, "200": { "description": "Tag is already assigned to the Api.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" } }, "default": { @@ -1953,7 +1953,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", @@ -2067,7 +2067,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2116,7 +2116,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2129,7 +2129,7 @@ "200": { "description": "Gets the description of the tag specified by its identifier in scope if the Api.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagDescriptionContract" + "$ref": "./apimtags.json#/definitions/TagDescriptionContract" }, "headers": { "ETag": { @@ -2168,14 +2168,14 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#./apimtags.json/definitions/TagDescriptionCreateParameters" + "$ref": "./apimtags.json#/definitions/TagDescriptionCreateParameters" }, "description": "Create parameters." }, @@ -2197,13 +2197,13 @@ "201": { "description": "Tag Description was created for the Api.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagDescriptionContract" + "$ref": "./apimtags.json#/definitions/TagDescriptionContract" } }, "200": { "description": "Tag Description was updated for the Api.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagDescriptionContract" + "$ref": "./apimtags.json#/definitions/TagDescriptionContract" } }, "default": { @@ -2236,7 +2236,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json index 7e6bfcadfe40..099944c4d7e5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json @@ -289,7 +289,11 @@ "name": "deleteSubscriptions", "in": "query", "required": false, - "type": "boolean", + "type": "string", + "enum": [ + "true", + "false" + ], "description": "Delete existing subscriptions to the product or not." }, { @@ -1000,7 +1004,7 @@ "$ref": "#/parameters/ProductIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1049,7 +1053,7 @@ "$ref": "#/parameters/ProductIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1062,7 +1066,7 @@ "200": { "description": "Gets the details of the tag specified by its identifier.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" }, "headers": { "ETag": { @@ -1101,7 +1105,7 @@ "$ref": "#/parameters/ProductIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", @@ -1121,13 +1125,13 @@ "201": { "description": "Tag was assigned to the Product.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" } }, "200": { "description": "Tag is already assigned to the Product.", "schema": { - "$ref": "#./apimtags.json#/definitions/TagContract" + "$ref": "./apimtags.json#/definitions/TagContract" } }, "default": { @@ -1160,7 +1164,7 @@ "$ref": "#/parameters/ProductIdParameter" }, { - "$ref": "#./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimtags.json#/parameters/TagIdParameter" }, { "name": "If-Match", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json index 80fb89538021..01b073ca72fb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json @@ -141,6 +141,21 @@ "description": "TagResource contract properties." }, "OperationEntityContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationEntityContractProperties", + "description": "Operation entity contract properties." + } + }, + "allOf": [ + { + "$ref": "./apimanagement.json#/definitions/Resource" + } + ], + "description": "Operation Entity Contract Properties." + }, + "OperationEntityContractProperties": { "properties": { "displayName": { "type": "string", @@ -182,7 +197,10 @@ "readOnly": true } }, - "description": "Operation Entity Contract Properties." + "required": [ + "displayName" + ], + "description": "Tag contract Properties." } }, "parameters": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json index 7a09befdeaae..8bff81022b8b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json @@ -209,7 +209,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TagCreateParameters" + "$ref": "#/definitions/TagCreateUpdateParameters" }, "description": "Create parameters." }, @@ -267,7 +267,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TagUpdateParameters" + "$ref": "#/definitions/TagCreateUpdateParameters" }, "description": "Update parameters." }, @@ -392,7 +392,7 @@ ], "description": "Tag contract Properties." }, - "TagCreateParameters": { + "TagCreateUpdateParameters": { "properties": { "properties": { "x-ms-client-flatten": true, @@ -400,17 +400,7 @@ "description": "Properties supplied to Create Tag operation." } }, - "description": "Parameters supplied to the Create Tag operation." - }, - "TagUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/TagContractProperties", - "description": "Tag entity update contract properties." - } - }, - "description": "Parameters supplied to the Update Tag operation." + "description": "Parameters supplied to Create/Update Tag operations." }, "TagDescriptionCollection": { "properties": { @@ -477,7 +467,8 @@ }, "externalDocsUrl": { "type": "string", - "description": "Absolute URL of external resources describing the tag." + "description": "Absolute URL of external resources describing the tag.", + "maxLength": 2000 }, "externalDocsDescription": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json index d0c9e049b4e8..ee404b0137f6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementCreateApiTagDescription.json @@ -5,7 +5,14 @@ "api-version": "2017-03-01", "subscriptionId": "subid", "apiId": "5931a75ae4bbd512a88c680b", - "tagId": "tagId1" + "tagId": "tagId1", + "parameters": { + "properties": { + "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API", + "externalDocsUrl": "http://some.url/additionaldoc", + "externalDocsDescription": "Description of the external docs resource" + } + } }, "responses": { "201": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json index 861e4799627d..30613b52de9c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json @@ -1,14 +1,14 @@ { - "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2017-03-01", - "subscriptionId": "subid", - "productId": "testproduct", - "deleteSubscriptions": "true", - "If-Match": "*" - }, - "responses": { - "204": {} - } + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "productId": "testproduct", + "deleteSubscriptions": "true", + "If-Match": "*" + }, + "responses": { + "204": { } + } } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json index 82d9b327036d..cee1e485086a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementHeadProductTag.json @@ -4,7 +4,7 @@ "resourceGroupName": "rg1", "api-version": "2017-03-01", "subscriptionId": "subid", - "apiId": "59306a29e4bbd510dc24e5f8", + "productId": "59306a29e4bbd510dc24e5f8", "tagId": "59306a29e4bbd510dc24e5f9" }, "responses": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json index e29b6022b008..e9f833e72527 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListApisByTags.json @@ -10,57 +10,81 @@ "body": { "value": [ { - "tag": { - "id": "/tags/t1", - "name": "tag1" - }, - "api": { - "id": "/apis/a1", - "name": "api1", - "apiRevision": "1", - "description": null, - "serviceUrl": "", - "path": "api1", - "protocols": null, - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020002", + "properties": { "displayName": "tag2" } + }, + "api": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api", + "properties": { + "displayName": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "protocols": [ + "https" + ], + "isCurrent": true, + "isOnline": true + } + } } }, { - "tag": { - "id": "/tags/t1", - "name": "tag1" - }, - "api": { - "id": "/apis/a2", - "name": "api2", - "apiRevision": "1", - "description": null, - "serviceUrl": "", - "path": "api2", - "protocols": null, - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020002", + "properties": { "displayName": "tag2" } + }, + "api": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api2", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api2", + "properties": { + "displayName": "Echo API2", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo2", + "protocols": [ + "https" + ], + "isCurrent": true, + "isOnline": true + } + } } }, { - "tag": { - "id": "/tags/t2", - "name": "tag2" - }, - "api": { - "id": "/apis/a2", - "name": "api2", - "apiRevision": "1", - "description": null, - "serviceUrl": "", - "path": "api2", - "protocols": null, - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { "displayName": "tag1" } + }, + "api": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api", + "properties": { + "displayName": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "protocols": [ + "https" + ], + "isCurrent": true, + "isOnline": true + } + } } } ], diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json index f9b81570aca9..3ea1fdcf596d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListOperationsByTags.json @@ -10,36 +10,52 @@ "200": { "body": { "value": [ - { - "tag": { - "id": "/tags/t1", - "name": "tag1" - }, - "operation": { - "id": "/apis/a1/operations/o2", - "apiName": "api1", - "apiRevision": "1", - "apiVersion": null, - "name": "api2", - "method": "GET", - "urlTemplate": "/op1", - "description": null + { + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { "displayName": "tag1" } + }, + "operation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiId1/operations/opid1", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "opid1", + "properties": { + "apiName": "api1", + "apiRevision": "1", + "apiVersion": null, + "displayName": "apiop1", + "method": "GET", + "urlTemplate": "/op1", + "description": "some operation" + } + } } }, { - "tag": { - "id": "/tags/t1", - "name": "tag1" - }, - "operation": { - "id": "/apis/a1/operations/o1", - "apiName": "api1", - "apiRevision": "1", - "apiVersion": null, - "name": "api22", - "method": "GET", - "urlTemplate": "/op2", - "description": null + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { "displayName": "tag1" } + }, + "operation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiId1/operations/opid2", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "opid2", + "properties": { + "apiName": "api1", + "apiRevision": "1", + "apiVersion": null, + "displayName": "apiop2", + "method": "GET", + "urlTemplate": "/op2", + "description": "some operation" + } + } } } ], diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json index db97c916b23f..f6f5a38416ab 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementListTagResources.json @@ -10,58 +10,106 @@ "body": { "value": [ { - "tag": { - "id": "/tags/t1", - "name": "tag1" - }, - "operation": { - "id": "/apis/a1/operations/o2", - "apiName": "api1", - "apiRevision": "1", - "apiVersion": null, - "name": "api2", - "method": "GET", - "urlTemplate": "/op1", - "description": null + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { "displayName": "tag1" } + }, + "operation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiId1/operations/opid1", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "opid1", + "properties": { + "apiName": "api1", + "apiRevision": "1", + "apiVersion": null, + "displayName": "apiop1", + "method": "GET", + "urlTemplate": "/op1", + "description": "some operation" + } + } } }, { - "tag": { - "id": "/tags/t1", - "name": "tag1" - }, - "api": { - "id": "/apis/a1", - "name": "api1", - "apiRevision": "1", - "description": null, - "serviceUrl": "", - "path": "api1", - "protocols": null, - "authenticationSettings": null, - "subscriptionKeyParameterNames": null, - "isCurrent": true + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020001", + "properties": { "displayName": "tag1" } + }, + "operation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiId1/operations/opid2", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "opid2", + "properties": { + "apiName": "api1", + "apiRevision": "1", + "apiVersion": null, + "displayName": "apiop2", + "method": "GET", + "urlTemplate": "/op2", + "description": "some operation" + } + } } }, { - "tag": { - "id": "/tags/t1", - "name": "tag1" - }, - "product": { - "id": "/products/p1", - "name": "product1", - "description": null, - "terms": null, - "subscriptionRequired": true, - "approvalRequired": false, - "subscriptionsLimit": null, - "state": "notPublished" + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020002", + "properties": { "displayName": "tag2" } + }, + "api": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api", + "type": "Microsoft.ApiManagement/service/apis", + "name": "echo-api", + "properties": { + "displayName": "Echo API", + "apiRevision": "1", + "serviceUrl": "http://echoapi.cloudapp.net/api", + "path": "echo", + "protocols": [ + "https" + ], + "isCurrent": true, + "isOnline": true + } + } + } + }, + { + "properties": { + "tag": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002", + "type": "Microsoft.ApiManagement/service/tags", + "name": "5600b59375ff190048020002", + "properties": { "displayName": "tag2" } + }, + "product": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter", + "type": "Microsoft.ApiManagement/service/products", + "name": "starter", + "properties": { + "displayName": "Starter", + "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.", + "terms": "", + "subscriptionRequired": true, + "approvalRequired": false, + "subscriptionsLimit": 1, + "state": "published" + } + } } } - ], - "nextLink": "" - } + ] + }, + "nextLink": "" } } -} \ No newline at end of file +} From a79b720fd978233223ee4d7038bf179de36ebc96 Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Tue, 16 Jan 2018 11:17:40 -0800 Subject: [PATCH 04/10] some small changes and examples fixes after code review --- .../stable/2017-03-01/apimtagresources.json | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json index 01b073ca72fb..e0f5e9ef1e15 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json @@ -197,10 +197,7 @@ "readOnly": true } }, - "required": [ - "displayName" - ], - "description": "Tag contract Properties." + "description": "Operation Entity contract Properties." } }, "parameters": { From 0b4fe989cdab04e803022647d8ce2603dd94396c Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Wed, 17 Jan 2018 12:27:18 -0800 Subject: [PATCH 05/10] operation IDs changed after code review --- .../stable/2017-03-01/apimapis.json | 26 +++++++++---------- .../stable/2017-03-01/apimapisbytags.json | 2 +- .../stable/2017-03-01/apimproducts.json | 8 +++--- .../stable/2017-03-01/apimtags.json | 6 ++--- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json index 55d0462d0f63..3b1a03c127d3 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json @@ -856,7 +856,7 @@ "tags": [ "OperationTags" ], - "operationId": "Tags_ListByOperation", + "operationId": "Tag_ListByOperation", "description": "Lists all Tags associated with the Operation.", "x-ms-examples": { "ApiManagementGetTagsForOperation": { @@ -1028,7 +1028,7 @@ "tags": [ "OperationTags" ], - "operationId": "OperationTag_CreateOrUpdate", + "operationId": "Tag_AssignToOperation", "description": "Assign tag to the Operation.", "x-ms-examples": { "ApiManagementCreateOperationTag": { @@ -1090,7 +1090,7 @@ "tags": [ "OperationTags" ], - "operationId": "OperationTag_Delete", + "operationId": "Tag_DetachFromOperation", "description": "Detach the tag from the Operation.", "x-ms-examples": { "ApiManagementDeleteOperationTag": { @@ -1145,7 +1145,7 @@ "tags": [ "OperationsByTags" ], - "operationId": "OperationsByTags_List", + "operationId": "Operation_ListByTags", "description": "Lists a collection of operations associated with tags.", "x-ms-examples": { "ApiManagementListOperationsByTags": { @@ -1713,7 +1713,7 @@ "tags": [ "ApiTags" ], - "operationId": "Tags_ListByApi", + "operationId": "Tag_ListByApi", "description": "Lists all Tags associated with the API.", "x-ms-examples": { "ApiManagementGetTagsForApi": { @@ -1775,7 +1775,7 @@ "tags": [ "ApiTags" ], - "operationId": "Tag_HeadByApi", + "operationId": "Tag_GetEntityStateByApi", "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { "ApiManagementHeadApiTag": { @@ -1876,7 +1876,7 @@ "tags": [ "ApiTags" ], - "operationId": "Tag_CreateOrUpdateForApi", + "operationId": "Tag_AssignToApi", "description": "Assign tag to the Api.", "x-ms-examples": { "ApiManagementCreateApiTag": { @@ -1935,7 +1935,7 @@ "tags": [ "ApiTags" ], - "operationId": "Tag_DeleteFromApi", + "operationId": "Tag_DetachFromApi", "description": "Detach the tag from the Api.", "x-ms-examples": { "ApiManagementDeleteApiTag": { @@ -1987,7 +1987,7 @@ "tags": [ "ApiTagDescriptions" ], - "operationId": "TagDescriptions_ListByApi", + "operationId": "TagDescription_ListByApi", "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", "x-ms-examples": { "ApiManagementGetTagDescriptionsForApi": { @@ -2049,7 +2049,7 @@ "tags": [ "ApiTagDescriptions" ], - "operationId": "TagDescription_HeadByApi", + "operationId": "TagDescription_GetEntityState", "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { "ApiManagementHeadApiTagDescription": { @@ -2098,7 +2098,7 @@ "tags": [ "ApiTagDescriptions" ], - "operationId": "TagDescription_GetByApi", + "operationId": "TagDescription_Get", "description": "Get tag associated with the API.", "x-ms-examples": { "ApiManagementGetApiTagDescription": { @@ -2150,7 +2150,7 @@ "tags": [ "ApiTagDescriptions" ], - "operationId": "TagDescription_CreateOrUpdateForApi", + "operationId": "TagDescription_CreateOrUpdate", "description": "Create/Update tag fescription in scope of the Api.", "x-ms-examples": { "ApiManagementCreateApiTagDescription": { @@ -2218,7 +2218,7 @@ "tags": [ "ApiTagDescriptions" ], - "operationId": "TagDescription_DeleteFromApi", + "operationId": "TagDescription_Delete", "description": "Delete tag description for the Api.", "x-ms-examples": { "ApiManagementDeleteApiTagDescription": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json index b68826998e9c..f1dbcab6fe42 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapisbytags.json @@ -38,7 +38,7 @@ "tags": [ "ApisByTags" ], - "operationId": "ApisByTags_ListByService", + "operationId": "Apis_ListByTags", "description": "Lists a collection of apis associated with tags.", "x-ms-examples": { "ApiManagementListApisByTags": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json index 099944c4d7e5..15161641f5b0 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json @@ -924,7 +924,7 @@ "tags": [ "ProductTags" ], - "operationId": "Tags_ListByProduct", + "operationId": "Tag_ListByProduct", "description": "Lists all Tags associated with the Product.", "x-ms-examples": { "ApiManagementGetTagsForProduct": { @@ -986,7 +986,7 @@ "tags": [ "ProductTags" ], - "operationId": "Tag_HeadByProduct", + "operationId": "Tag_GetEntityStateByProduct", "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { "ApiManagementHeadProductTag": { @@ -1087,7 +1087,7 @@ "tags": [ "ProductTags" ], - "operationId": "Tag_CreateOrUpdateForProduct", + "operationId": "Tag_AssignToProduct", "description": "Assign tag to the Product.", "x-ms-examples": { "ApiManagementCreateProductTag": { @@ -1146,7 +1146,7 @@ "tags": [ "ProductTags" ], - "operationId": "Tag_DeleteFromProduct", + "operationId": "Tag_DetachFromProduct", "description": "Detach the tag from the Product.", "x-ms-examples": { "ApiManagementDeleteProductTag": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json index 8bff81022b8b..b59a2d3144fe 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json @@ -39,7 +39,7 @@ "tags": [ "Tags" ], - "operationId": "Tags_ListByService", + "operationId": "Tag_ListByService", "description": "Lists a collection of tags defined within a service instance.", "x-ms-examples": { "ApiManagementListTags": { @@ -92,7 +92,7 @@ "tags": [ "Tags" ], - "operationId": "Tag_Head", + "operationId": "Tag_GetEntityState", "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { "ApiManagementGetTag": { @@ -188,7 +188,7 @@ "Tags" ], "operationId": "Tag_CreateOrUpdate", - "description": "Creates or Updates a tag.", + "description": "Creates a tag.", "x-ms-examples": { "ApiManagementCreateTag": { "$ref": "./examples/ApiManagementCreateTag.json" From 3b1270a909de8d74bd3b783ace9ab8ab996cfe81 Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Wed, 17 Jan 2018 15:36:06 -0800 Subject: [PATCH 06/10] changes after code review, suppressions --- .../stable/2017-03-01/apimapis.json | 2 +- .../stable/2017-03-01/apimtagresources.json | 2 +- specification/apimanagement/resource-manager/readme.md | 10 ++++++++++ 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json index 3b1a03c127d3..f673c0bd1259 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json @@ -921,7 +921,7 @@ "tags": [ "OperationTags" ], - "operationId": "Tag_HeadByOperation", + "operationId": "Tag_GetEntityStateByOperation", "description": "Gets the entity state version of the tag specified by its identifier.", "x-ms-examples": { "ApiManagementHeadOperationTag": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json index e0f5e9ef1e15..5f7a83abed39 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json @@ -38,7 +38,7 @@ "tags": [ "TagResources" ], - "operationId": "TagResources_ListByService", + "operationId": "TagResource_ListByService", "description": "Lists a collection of resources associated with tags.", "x-ms-examples": { "ApiManagementListTagResources": { diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index 1905b51ddf73..048983d445e3 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -31,6 +31,16 @@ openapi-type: arm tag: package-2017-03 ``` +## Suppression +``` yaml +directive: + - suppress: R3016 + reason: existing properties, can't be changed without breaking API. + #where: + # - $.definitions.ApiManagementServiceUploadCertificateParameters.properties.certificate_password + # - $.definitions.QuotaCounterContract.properties.Value + +``` ### Tag: package-2017-03 From fae545dc252f9ad3b3073e947fd18d6114264a96 Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Wed, 31 Jan 2018 11:02:32 -0800 Subject: [PATCH 07/10] moved all tags related paths into apimtags.json file --- .../stable/2017-03-01/apimapis.json | 1344 +++-------------- .../stable/2017-03-01/apimtags.json | 902 +++++++++++ 2 files changed, 1123 insertions(+), 1123 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json index a182ae7374d4..f23570124aef 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json @@ -104,7 +104,7 @@ "x-ms-odata": "#/definitions/ApiContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}": { "head": { "tags": [ "Apis" @@ -137,10 +137,10 @@ "200": { "description": "Specified API entity exists and current entity state version is present in the ETag header.", "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -148,10 +148,10 @@ "schema": { "$ref": "./apimanagement.json#/definitions/ErrorResponse" } - } + } } }, - "get": { + "get": { "tags": [ "Apis" ], @@ -475,7 +475,7 @@ "ApiManagementListApiReleases": { "$ref": "./examples/ApiManagementListApiReleases.json" } - }, + }, "parameters": [ { "name": "$filter", @@ -511,35 +511,35 @@ "x-ms-odata": "#/definitions/ApiReleaseContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}": { - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "name": "releaseId", - "in": "path", - "required": true, - "type": "string", - "description": "Release identifier within an API. Must be unique in the current API Management service instance.", - "minLength": 1, - "maxLength": 256, - "pattern": "^[^*#&+:<>?]+$" - } - ], - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}": { + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "name": "releaseId", + "in": "path", + "required": true, + "type": "string", + "description": "Release identifier within an API. Must be unique in the current API Management service instance.", + "minLength": 1, + "maxLength": 256, + "pattern": "^[^*#&+:<>?]+$" + } + ], + "get": { "tags": [ "Releases" ], @@ -773,10 +773,10 @@ "200": { "description": "Specified API operation entity exists and current entity state version is present in the ETag header.", "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -787,7 +787,7 @@ } } }, - "get": { + "get": { "tags": [ "Operations" ], @@ -1097,10 +1097,10 @@ "200": { "description": "Specified API operation policy entity exists and current entity state version is present in the ETag header.", "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -1111,7 +1111,7 @@ } } }, - "get": { + "get": { "tags": [ "ApiOperationPolicies" ], @@ -1291,16 +1291,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { "get": { "tags": [ - "OperationTags" + "ApiProduct" ], - "operationId": "Tag_ListByOperation", - "description": "Lists all Tags associated with the Operation.", + "operationId": "ApiProduct_ListByApis", + "description": "Lists all Products, which the API is part of.", "x-ms-examples": { - "ApiManagementGetTagsForOperation": { - "$ref": "./examples/ApiManagementGetTagsForOperation.json" + "ApiManagementGetProductsForApi": { + "$ref": "./examples/ApiManagementGetProductsForApi.json" } }, "parameters": [ @@ -1313,15 +1313,12 @@ { "$ref": "#/parameters/ApiIdParameter" }, - { - "$ref": "#/parameters/OperationIdParameter" - }, { "name": "$filter", "in": "query", "required": false, "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" }, { "$ref": "./apimanagement.json#/parameters/TopQueryParameter" @@ -1338,9 +1335,9 @@ ], "responses": { "200": { - "description": "The operation returns a collection of tags associated with the Operation entity.", + "description": "The operation returns a collection of products which have the Api entity.", "schema": { - "$ref": "./apimtags.json#/definitions/TagCollection" + "$ref": "./apimproducts.json#/definitions/ProductCollection" } }, "default": { @@ -1353,19 +1350,19 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "./apimtags.json#/definitions/TagContract" + "x-ms-odata": "./apimproducts.json#/definitions/ProductContract" } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { - "head": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { + "get": { "tags": [ - "OperationTags" + "ApiPolicy" ], - "operationId": "Tag_GetEntityStateByOperation", - "description": "Gets the entity state version of the tag specified by its identifier.", + "operationId": "ApiPolicy_ListByApi", + "description": "Get the policy configuration at the API level.", "x-ms-examples": { - "ApiManagementHeadOperationTag": { - "$ref": "./examples/ApiManagementHeadOperationTag.json" + "ApiManagementListApiPolicies": { + "$ref": "./examples/ApiManagementListApiPolicies.json" } }, "parameters": [ @@ -1378,12 +1375,6 @@ { "$ref": "#/parameters/ApiIdParameter" }, - { - "$ref": "#/parameters/OperationIdParameter" - }, - { - "$ref": "./apimtags.json#/parameters/TagIdParameter" - }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -1393,7 +1384,10 @@ ], "responses": { "200": { - "description": "Empty response body, ETag header entity state version.", + "description": "Apis Policy Collection.", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyCollection" + }, "headers": { "ETag": { "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", @@ -1408,16 +1402,18 @@ } } } - }, - "get": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { + "head": { "tags": [ - "OperationTags" + "ApiPolicy" ], - "operationId": "Tag_GetByOperation", - "description": "Get tag associated with the Operation.", + "operationId": "ApiPolicy_GetEntityTag", + "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", "x-ms-examples": { - "ApiManagementGetOperationTag": { - "$ref": "./examples/ApiManagementGetOperationTag.json" + "ApiManagementHeadApiPolicy": { + "$ref": "./examples/ApiManagementHeadApiPolicy.json" } }, "parameters": [ @@ -1431,10 +1427,56 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiPolicy" + ], + "operationId": "ApiPolicy_Get", + "description": "Get the policy configuration at the API level.", + "x-ms-examples": { + "ApiManagementGetApiPolicy": { + "$ref": "./examples/ApiManagementGetApiPolicy.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdRevParameter" }, { - "$ref": "./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1445,9 +1487,9 @@ ], "responses": { "200": { - "description": "Gets the details of the tag specified by its identifier.", + "description": "Api Policy information.", "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" + "$ref": "./apimanagement.json#/definitions/PolicyContract" }, "headers": { "ETag": { @@ -1466,13 +1508,13 @@ }, "put": { "tags": [ - "OperationTags" + "ApiPolicy" ], - "operationId": "Tag_AssignToOperation", - "description": "Assign tag to the Operation.", + "operationId": "ApiPolicy_CreateOrUpdate", + "description": "Creates or updates policy configuration for the API.", "x-ms-examples": { - "ApiManagementCreateOperationTag": { - "$ref": "./examples/ApiManagementCreateOperationTag.json" + "ApiManagementCreateApiPolicy": { + "$ref": "./examples/ApiManagementCreateApiPolicy.json" } }, "parameters": [ @@ -1483,19 +1525,25 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" + "$ref": "#/parameters/ApiIdRevParameter" }, { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { - "$ref": "./apimtags.json#/parameters/TagIdParameter" + "name": "parameters", + "in": "body", + "schema": { + "$ref": "./apimanagement.json#/definitions/PolicyContract" + }, + "required": true, + "description": "The policy contents to apply." }, { "name": "If-Match", "in": "header", - "required": false, - "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "required": true, + "description": "The entity state (Etag) version of the Api Policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", "type": "string" }, { @@ -1507,15 +1555,15 @@ ], "responses": { "201": { - "description": "Tag was assigned to the Operation.", + "description": "Api policy configuration was successfully created.", "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" + "$ref": "./apimanagement.json#/definitions/PolicyContract" } }, "200": { - "description": "Tag is already assigned to the Operation.", + "description": "Api policy configuration of the tenant was successfully updated.", "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" + "$ref": "./apimanagement.json#/definitions/PolicyContract" } }, "default": { @@ -1528,13 +1576,13 @@ }, "delete": { "tags": [ - "OperationTags" + "ApiPolicy" ], - "operationId": "Tag_DetachFromOperation", - "description": "Detach the tag from the Operation.", + "operationId": "ApiPolicy_Delete", + "description": "Deletes the policy configuration at the Api.", "x-ms-examples": { - "ApiManagementDeleteOperationTag": { - "$ref": "./examples/ApiManagementDeleteOperationTag.json" + "ApiManagementDeleteApiPolicy": { + "$ref": "./examples/ApiManagementDeleteApiPolicy.json" } }, "parameters": [ @@ -1545,19 +1593,16 @@ "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" }, { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "#/parameters/OperationIdParameter" + "$ref": "#/parameters/ApiIdRevParameter" }, { - "$ref": "./apimtags.json#/parameters/TagIdParameter" + "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" }, { "name": "If-Match", "in": "header", "required": true, - "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "description": "The entity state (Etag) version of the Api policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", "type": "string" }, { @@ -1569,7 +1614,7 @@ ], "responses": { "204": { - "description": "Successfully detached the tag from the Operation." + "description": "Successfully deleted the policy configuration at the API level." }, "default": { "description": "Error response describing why the operation failed.", @@ -1580,16 +1625,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { "get": { "tags": [ - "OperationsByTags" + "ApiSchema" ], - "operationId": "Operation_ListByTags", - "description": "Lists a collection of operations associated with tags.", + "operationId": "ApiSchema_ListByApi", + "description": "Get the schema configuration at the API level.", "x-ms-examples": { - "ApiManagementListOperationsByTags": { - "$ref": "./examples/ApiManagementListOperationsByTags.json" + "ApiManagementListApiSchemas": { + "$ref": "./examples/ApiManagementListApiSchemas.json" } }, "parameters": [ @@ -1602,19 +1647,6 @@ { "$ref": "#/parameters/ApiIdParameter" }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" }, @@ -1624,28 +1656,39 @@ ], "responses": { "200": { - "description": "Lists a collection of TagResource entities.", + "description": "Apis Schema Collection.", + "schema": { + "$ref": "#/definitions/SchemaCollection" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", "schema": { - "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" + "$ref": "./apimanagement.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { + "head": { "tags": [ - "ApiProduct" + "ApiSchema" ], - "operationId": "ApiProduct_ListByApis", - "description": "Lists all Products, which the API is part of.", + "operationId": "ApiSchema_GetEntityTag", + "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", "x-ms-examples": { - "ApiManagementGetProductsForApi": { - "$ref": "./examples/ApiManagementGetProductsForApi.json" + "ApiManagementHeadApiSchema": { + "$ref": "./examples/ApiManagementHeadApiSchema.json" } }, "parameters": [ @@ -1659,17 +1702,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------|------------------------|---------------------------------------------|\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + "$ref": "#/parameters/SchemaIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -1680,947 +1713,12 @@ ], "responses": { "200": { - "description": "The operation returns a collection of products which have the Api entity.", - "schema": { - "$ref": "./apimproducts.json#/definitions/ProductCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimproducts.json#/definitions/ProductContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies": { - "get": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_ListByApi", - "description": "Get the policy configuration at the API level.", - "x-ms-examples": { - "ApiManagementListApiPolicies": { - "$ref": "./examples/ApiManagementListApiPolicies.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Apis Policy Collection.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyCollection" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}": { - "head": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_GetEntityTag", - "description": "Gets the entity state (Etag) version of the API policy specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiPolicy": { - "$ref": "./examples/ApiManagementHeadApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified API Policy entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_Get", - "description": "Get the policy configuration at the API level.", - "x-ms-examples": { - "ApiManagementGetApiPolicy": { - "$ref": "./examples/ApiManagementGetApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Policy information.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_CreateOrUpdate", - "description": "Creates or updates policy configuration for the API.", - "x-ms-examples": { - "ApiManagementCreateApiPolicy": { - "$ref": "./examples/ApiManagementCreateApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "parameters", - "in": "body", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - }, - "required": true, - "description": "The policy contents to apply." - }, - { - "name": "If-Match", - "in": "header", - "required": true, - "description": "The entity state (Etag) version of the Api Policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", - "type": "string" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api policy configuration was successfully created.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - } - }, - "200": { - "description": "Api policy configuration of the tenant was successfully updated.", - "schema": { - "$ref": "./apimanagement.json#/definitions/PolicyContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiPolicy" - ], - "operationId": "ApiPolicy_Delete", - "description": "Deletes the policy configuration at the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiPolicy": { - "$ref": "./examples/ApiManagementDeleteApiPolicy.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdRevParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/PolicyIdParameter" - }, - { - "name": "If-Match", - "in": "header", - "required": true, - "description": "The entity state (Etag) version of the Api policy to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", - "type": "string" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Successfully deleted the policy configuration at the API level." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas": { - "get": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_ListByApi", - "description": "Get the schema configuration at the API level.", - "x-ms-examples": { - "ApiManagementListApiSchemas": { - "$ref": "./examples/ApiManagementListApiSchemas.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Apis Schema Collection.", - "schema": { - "$ref": "#/definitions/SchemaCollection" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}": { - "head": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_GetEntityTag", - "description": "Gets the entity state (Etag) version of the schema specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiSchema": { - "$ref": "./examples/ApiManagementHeadApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "#/parameters/SchemaIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Specified schema entity exists and current entity state version is present in the ETag header.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_Get", - "description": "Get the schema configuration at the API level.", - "x-ms-examples": { - "ApiManagementGetApiSchema": { - "$ref": "./examples/ApiManagementGetApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "#/parameters/SchemaIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Api Schema information.", - "schema": { - "$ref": "#/definitions/SchemaContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_CreateOrUpdate", - "description": "Creates or updates schema configuration for the API.", - "x-ms-examples": { - "ApiManagementCreateApiSchema": { - "$ref": "./examples/ApiManagementCreateApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "#/parameters/SchemaIdParameter" - }, - { - "name": "parameters", - "in": "body", - "schema": { - "$ref": "#/definitions/SchemaContract" - }, - "required": true, - "description": "The schema contents to apply." - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "description": "The entity state (Etag) version of the Api Schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", - "type": "string" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Api schema configuration was successfully created.", - "schema": { - "$ref": "#/definitions/SchemaContract" - } - }, - "200": { - "description": "Api schema configuration of the tenant was successfully updated.", - "schema": { - "$ref": "#/definitions/SchemaContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiSchema" - ], - "operationId": "ApiSchema_Delete", - "description": "Deletes the schema configuration at the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiSchema": { - "$ref": "./examples/ApiManagementDeleteApiSchema.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "#/parameters/SchemaIdParameter" - }, - { - "name": "If-Match", - "in": "header", - "required": true, - "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", - "type": "string" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Successfully deleted the schema configuration at the API level." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { - "get": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_ListByApi", - "description": "Lists all Tags associated with the API.", - "x-ms-examples": { - "ApiManagementGetTagsForApi": { - "$ref": "./examples/ApiManagementGetTagsForApi.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tags associated with the Api entity.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimtags.json#/definitions/TagContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { - "head": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_GetEntityStateByApi", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiTag": { - "$ref": "./examples/ApiManagementHeadApiTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimtags.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_GetByApi", - "description": "Get tag associated with the API.", - "x-ms-examples": { - "ApiManagementGetApiTag": { - "$ref": "./examples/ApiManagementGetApiTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimtags.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Gets the details of the tag specified by its identifier.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" - }, - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_AssignToApi", - "description": "Assign tag to the Api.", - "x-ms-examples": { - "ApiManagementCreateApiTag": { - "$ref": "./examples/ApiManagementCreateApiTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimtags.json#/parameters/TagIdParameter" - }, - { - "name": "If-Match", - "in": "header", - "required": false, - "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", - "type": "string" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Tag was assigned to the Api.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" - } - }, - "200": { - "description": "Tag is already assigned to the Api.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagContract" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiTags" - ], - "operationId": "Tag_DetachFromApi", - "description": "Detach the tag from the Api.", - "x-ms-examples": { - "ApiManagementDeleteApiTag": { - "$ref": "./examples/ApiManagementDeleteApiTag.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimtags.json#/parameters/TagIdParameter" - }, - { - "name": "If-Match", - "in": "header", - "required": true, - "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", - "type": "string" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "Successfully detached the tag from the Api." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { - "get": { - "tags": [ - "ApiTagDescriptions" - ], - "operationId": "TagDescription_ListByApi", - "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", - "x-ms-examples": { - "ApiManagementGetTagDescriptionsForApi": { - "$ref": "./examples/ApiManagementGetTagDescriptionsForApi.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" - }, - { - "$ref": "./apimanagement.json#/parameters/TopQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", - "schema": { - "$ref": "./apimtags.json#/definitions/TagDescriptionCollection" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./apimanagement.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "./apimtags.json#/definitions/TagDescriptionContract" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagId}": { - "head": { - "tags": [ - "ApiTagDescriptions" - ], - "operationId": "TagDescription_GetEntityState", - "description": "Gets the entity state version of the tag specified by its identifier.", - "x-ms-examples": { - "ApiManagementHeadApiTagDescription": { - "$ref": "./examples/ApiManagementHeadApiTagDescription.json" - } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/ApiIdParameter" - }, - { - "$ref": "./apimtags.json#/parameters/TagIdParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Empty response body, ETag header entity state version.", - "headers": { - "ETag": { - "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", - "type": "string" - } + "description": "Specified schema entity exists and current entity state version is present in the ETag header.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } } }, "default": { @@ -2631,15 +1729,15 @@ } } }, - "get": { + "get": { "tags": [ - "ApiTagDescriptions" + "ApiSchema" ], - "operationId": "TagDescription_Get", - "description": "Get tag associated with the API.", + "operationId": "ApiSchema_Get", + "description": "Get the schema configuration at the API level.", "x-ms-examples": { - "ApiManagementGetApiTagDescription": { - "$ref": "./examples/ApiManagementGetApiTagDescription.json" + "ApiManagementGetApiSchema": { + "$ref": "./examples/ApiManagementGetApiSchema.json" } }, "parameters": [ @@ -2653,7 +1751,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "./apimtags.json#/parameters/TagIdParameter" + "$ref": "#/parameters/SchemaIdParameter" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -2664,9 +1762,9 @@ ], "responses": { "200": { - "description": "Gets the description of the tag specified by its identifier in scope if the Api.", + "description": "Api Schema information.", "schema": { - "$ref": "./apimtags.json#/definitions/TagDescriptionContract" + "$ref": "#/definitions/SchemaContract" }, "headers": { "ETag": { @@ -2685,13 +1783,13 @@ }, "put": { "tags": [ - "ApiTagDescriptions" + "ApiSchema" ], - "operationId": "TagDescription_CreateOrUpdate", - "description": "Create/Update tag fescription in scope of the Api.", + "operationId": "ApiSchema_CreateOrUpdate", + "description": "Creates or updates schema configuration for the API.", "x-ms-examples": { - "ApiManagementCreateApiTagDescription": { - "$ref": "./examples/ApiManagementCreateApiTagDescription.json" + "ApiManagementCreateApiSchema": { + "$ref": "./examples/ApiManagementCreateApiSchema.json" } }, "parameters": [ @@ -2705,22 +1803,22 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "./apimtags.json#/parameters/TagIdParameter" + "$ref": "#/parameters/SchemaIdParameter" }, { "name": "parameters", "in": "body", - "required": true, "schema": { - "$ref": "./apimtags.json#/definitions/TagDescriptionCreateParameters" + "$ref": "#/definitions/SchemaContract" }, - "description": "Create parameters." + "required": true, + "description": "The schema contents to apply." }, { "name": "If-Match", "in": "header", "required": false, - "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "description": "The entity state (Etag) version of the Api Schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", "type": "string" }, { @@ -2732,15 +1830,15 @@ ], "responses": { "201": { - "description": "Tag Description was created for the Api.", + "description": "Api schema configuration was successfully created.", "schema": { - "$ref": "./apimtags.json#/definitions/TagDescriptionContract" + "$ref": "#/definitions/SchemaContract" } }, "200": { - "description": "Tag Description was updated for the Api.", + "description": "Api schema configuration of the tenant was successfully updated.", "schema": { - "$ref": "./apimtags.json#/definitions/TagDescriptionContract" + "$ref": "#/definitions/SchemaContract" } }, "default": { @@ -2753,13 +1851,13 @@ }, "delete": { "tags": [ - "ApiTagDescriptions" + "ApiSchema" ], - "operationId": "TagDescription_Delete", - "description": "Delete tag description for the Api.", + "operationId": "ApiSchema_Delete", + "description": "Deletes the schema configuration at the Api.", "x-ms-examples": { - "ApiManagementDeleteApiTagDescription": { - "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" + "ApiManagementDeleteApiSchema": { + "$ref": "./examples/ApiManagementDeleteApiSchema.json" } }, "parameters": [ @@ -2773,7 +1871,7 @@ "$ref": "#/parameters/ApiIdParameter" }, { - "$ref": "./apimtags.json#/parameters/TagIdParameter" + "$ref": "#/parameters/SchemaIdParameter" }, { "name": "If-Match", @@ -2791,7 +1889,7 @@ ], "responses": { "204": { - "description": "Successfully deleted tag description for the Api." + "description": "Successfully deleted the schema configuration at the API level." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json index b59a2d3144fe..168e5d4ad598 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json @@ -344,6 +344,908 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags": { + "get": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_ListByApi", + "description": "Lists all Tags associated with the API.", + "x-ms-examples": { + "ApiManagementGetTagsForApi": { + "$ref": "./examples/ApiManagementGetTagsForApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Api entity.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}": { + "head": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_GetEntityStateByApi", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTag": { + "$ref": "./examples/ApiManagementHeadApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_GetByApi", + "description": "Get tag associated with the API.", + "x-ms-examples": { + "ApiManagementGetApiTag": { + "$ref": "./examples/ApiManagementGetApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_AssignToApi", + "description": "Assign tag to the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTag": { + "$ref": "./examples/ApiManagementCreateApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Api.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Api.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiTags" + ], + "operationId": "Tag_DetachFromApi", + "description": "Detach the tag from the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTag": { + "$ref": "./examples/ApiManagementDeleteApiTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Successfully detached the tag from the Api." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions": { + "get": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_ListByApi", + "description": "Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations", + "x-ms-examples": { + "ApiManagementGetTagDescriptionsForApi": { + "$ref": "./examples/ApiManagementGetTagDescriptionsForApi.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tagDescriptions associated with the Api entity.", + "schema": { + "$ref": "#/definitions/TagDescriptionCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagDescriptionContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagId}": { + "head": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_GetEntityState", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadApiTagDescription": { + "$ref": "./examples/ApiManagementHeadApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_Get", + "description": "Get tag associated with the API.", + "x-ms-examples": { + "ApiManagementGetApiTagDescription": { + "$ref": "./examples/ApiManagementGetApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the description of the tag specified by its identifier in scope if the Api.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_CreateOrUpdate", + "description": "Create/Update tag fescription in scope of the Api.", + "x-ms-examples": { + "ApiManagementCreateApiTagDescription": { + "$ref": "./examples/ApiManagementCreateApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagDescriptionCreateParameters" + }, + "description": "Create parameters." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag Description was created for the Api.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + } + }, + "200": { + "description": "Tag Description was updated for the Api.", + "schema": { + "$ref": "#/definitions/TagDescriptionContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiTagDescriptions" + ], + "operationId": "TagDescription_Delete", + "description": "Delete tag description for the Api.", + "x-ms-examples": { + "ApiManagementDeleteApiTagDescription": { + "$ref": "./examples/ApiManagementDeleteApiTagDescription.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Successfully deleted tag description for the Api." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags": { + "get": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_ListByOperation", + "description": "Lists all Tags associated with the Operation.", + "x-ms-examples": { + "ApiManagementGetTagsForOperation": { + "$ref": "./examples/ApiManagementGetTagsForOperation.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation returns a collection of tags associated with the Operation entity.", + "schema": { + "$ref": "#/definitions/TagCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/TagContract" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/tags/{tagId}": { + "head": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_GetEntityStateByOperation", + "description": "Gets the entity state version of the tag specified by its identifier.", + "x-ms-examples": { + "ApiManagementHeadOperationTag": { + "$ref": "./examples/ApiManagementHeadOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Empty response body, ETag header entity state version.", + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_GetByOperation", + "description": "Get tag associated with the Operation.", + "x-ms-examples": { + "ApiManagementGetOperationTag": { + "$ref": "./examples/ApiManagementGetOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Gets the details of the tag specified by its identifier.", + "schema": { + "$ref": "#/definitions/TagContract" + }, + "headers": { + "ETag": { + "description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_AssignToOperation", + "description": "Assign tag to the Operation.", + "x-ms-examples": { + "ApiManagementCreateOperationTag": { + "$ref": "./examples/ApiManagementCreateOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "The entity state (Etag) version of the Tag to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Tag was assigned to the Operation.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "200": { + "description": "Tag is already assigned to the Operation.", + "schema": { + "$ref": "#/definitions/TagContract" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "OperationTags" + ], + "operationId": "Tag_DetachFromOperation", + "description": "Detach the tag from the Operation.", + "x-ms-examples": { + "ApiManagementDeleteOperationTag": { + "$ref": "./examples/ApiManagementDeleteOperationTag.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "$ref": "./apimapis.json#/parameters/OperationIdParameter" + }, + { + "$ref": "#/parameters/TagIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "description": "The entity state (Etag) version of the Api schema to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Successfully detached the tag from the Operation." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags": { + "get": { + "tags": [ + "OperationsByTags" + ], + "operationId": "Operation_ListByTags", + "description": "Lists a collection of operations associated with tags.", + "x-ms-examples": { + "ApiManagementListOperationsByTags": { + "$ref": "./examples/ApiManagementListOperationsByTags.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimapis.json#/parameters/ApiIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "| Field | Supported operators | Supported functions |\n|-------------|------------------------|---------------------------------------------|\n| id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| apiName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| method | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| urlTemplate | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |" + }, + { + "$ref": "./apimanagement.json#/parameters/TopQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SkipQueryParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists a collection of TagResource entities.", + "schema": { + "$ref": "./apimtagresources.json#/definitions/TagResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "./apimtagresources.json#/definitions/TagResourceContract" + } } }, "definitions": { From 6344a0a25e6e80e5141a13bc155dfaeb41535dd3 Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Wed, 31 Jan 2018 12:11:59 -0800 Subject: [PATCH 08/10] rolled back to boolean type in parameters --- .../stable/2017-03-01/apimproducts.json | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json index 16dd51854c99..e9d46432ef50 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json @@ -335,11 +335,7 @@ "name": "deleteSubscriptions", "in": "query", "required": false, - "type": "string", - "enum": [ - "true", - "false" - ], + "type": "boolean", "description": "Delete existing subscriptions to the product or not." }, { From a23c66761562b923b92a38bafc06a59c1204978c Mon Sep 17 00:00:00 2001 From: vfedonkin Date: Wed, 31 Jan 2018 12:17:53 -0800 Subject: [PATCH 09/10] rolled back to boolean type in parameters --- .../examples/ApiManagementDeleteProduct.json | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json index 30613b52de9c..861e4799627d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json @@ -1,14 +1,14 @@ { - "parameters": { - "serviceName": "apimService1", - "resourceGroupName": "rg1", - "api-version": "2017-03-01", - "subscriptionId": "subid", - "productId": "testproduct", - "deleteSubscriptions": "true", - "If-Match": "*" - }, - "responses": { - "204": { } - } + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2017-03-01", + "subscriptionId": "subid", + "productId": "testproduct", + "deleteSubscriptions": "true", + "If-Match": "*" + }, + "responses": { + "204": {} + } } \ No newline at end of file From 607d9784e40f3f7871312223c205386df1e6716d Mon Sep 17 00:00:00 2001 From: Garrett Serack Date: Wed, 7 Feb 2018 10:48:01 -0800 Subject: [PATCH 10/10] Update ApiManagementDeleteProduct.json --- .../2017-03-01/examples/ApiManagementDeleteProduct.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json index 861e4799627d..e42074c92f2c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementDeleteProduct.json @@ -5,10 +5,10 @@ "api-version": "2017-03-01", "subscriptionId": "subid", "productId": "testproduct", - "deleteSubscriptions": "true", + "deleteSubscriptions": true, "If-Match": "*" }, "responses": { "204": {} } -} \ No newline at end of file +}