AzureApiManagement new entity "Tag" documented #2257
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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": { | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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", | ||
|
Contributor
There was a problem hiding this comment. We don't see a lot of The
Contributor
Author
There was a problem hiding this comment. Done. The same for apis/operations/tags entities. |
||
| "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" | ||
|
Member
There was a problem hiding this comment.
maybe this is what the CI job is complaining about. #Resolved |
||
| }, | ||
| { | ||
| "$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", | ||
|
Contributor
There was a problem hiding this comment. I'd recommend this was just
Contributor
Author
There was a problem hiding this comment. @fearthecowboy |
||
| "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" | ||
|
Member
There was a problem hiding this comment.
check this #Resolved |
||
| }, | ||
| { | ||
| "$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" | ||
|
Member
There was a problem hiding this comment.
check this. #Resolved |
||
| }, | ||
| "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", | ||
|
Contributor
There was a problem hiding this comment. I'd recommend this was just
Contributor
Author
There was a problem hiding this comment. Renamed to Tag_AssignToProduct. Same for Tag_AssignToApi and Tag_AssignToOperation |
||
| "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", | ||
|
Contributor
There was a problem hiding this comment. I'd recommend this was just
Contributor
Author
There was a problem hiding this comment. Renamed to Tag_DetachFromProduct. Same for Tag_DetachFromApi and Tag_DetachFromOperation |
||
| "description": "Detach the tag from the Product.", | ||
|
Contributor
There was a problem hiding this comment. The description
Contributor
Author
There was a problem hiding this comment. Tag is really exists as an entity, it's just detached 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": { | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This operation is
Tags_ListByProductthe next isTag_HeadByProductThe prefix should be consistent between operations (
TagorTags, but not both)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have used a singular case in all other operations. @vfedonkin let's use Tag.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, using "Tag" everywhere.