Skip to content

Portal revision API #11738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weidongxu-microsoft merged 7 commits into from
Dec 4, 2020
Merged

Portal revision API #11738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
68739a1
Portal revision API
ygrik Nov 18, 2020
fa36862
fixed spec errors
ygrik Nov 18, 2020
5acbe57
fixed references
ygrik Nov 18, 2020
c53ae60
fixed return code on create and added long running operation properties
ygrik Nov 18, 2020
41bfa63
fixed create response
ygrik Nov 18, 2020
92b02a1
fixed comments
ygrik Nov 25, 2020
99b5ce5
small fix
ygrik Nov 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ...nt/resource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimanagement.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,16 @@
},
"x-ms-parameter-location": "method"
},
"PortalRevisionIdParameter": {
"name": "portalRevisionId",
"in": "path",
"required": true,
"type": "string",
"description": "Portal revision identifier. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 256,
"x-ms-parameter-location": "method"
},
"ProductIdParameter": {
"name": "productId",
"in": "path",
Expand Down
326 changes: 326 additions & 0 deletions ...ource-manager/Microsoft.ApiManagement/preview/2020-06-01-preview/apimportalrevisions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,326 @@
{
"swagger": "2.0",
"info": {
"title": "ApiManagementClient",
"description": "Use these REST APIs for performing operations in Azure API Management deployment.",
"version": "2020-06-01-preview"
},
"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}/portalRevisions": {
"get": {
"tags": [
"PortalRevision"
],
"operationId": "PortalRevision_ListByService",
"description": "Lists a collection of developer portal revision entities.",
"x-ms-examples": {
"ApiManagementListPortalRevisions": {
"$ref": "./examples/ApiManagementListPortalRevisions.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\r\n|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith|\n|isCurrent | eq, ne | |\n"
},
{
"$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 developer portal revision entities.",
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionCollection"
}
},
"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}/portalRevisions/{portalRevisionId}": {
"head": {
"tags": [
"PortalRevision"
],
"operationId": "PortalRevision_GetEntityTag",
"description": "Gets developer portal revision specified by its identifier.",
"x-ms-examples": {
"ApiManagementHeadPortalRevision": {
"$ref": "./examples/ApiManagementHeadPortalRevision.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Specified Portal revision 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": [
"PortalRevision"
],
"operationId": "PortalRevision_Get",
"description": "Gets developer portal revision specified by its identifier.",
"x-ms-examples": {
"ApiManagementGetPortalRevision": {
"$ref": "./examples/ApiManagementGetPortalRevision.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Gets the specified developer portal revision entity.",
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
},
"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": [
"PortalRevision"
],
"operationId": "PortalRevision_CreateOrUpdate",
"description": "Creates a new developer portal revision.",
"x-ms-examples": {
"ApiManagementCreatePortalRevision": {
"$ref": "./examples/ApiManagementCreatePortalRevision.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
}
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"202": {
"description": "Request to create developer portal revision was accepted."
},
"201": {
"description": "Developer portal revision was successfully created.",
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
},
"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-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
},
"patch": {
"tags": [
"PortalRevision"
],
"operationId": "PortalRevision_Update",
"description": "Updates the description of specified portal revision or makes it current.",
"x-ms-examples": {
"ApiManagementUpdatePortalRevision": {
"$ref": "./examples/ApiManagementUpdatePortalRevision.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/PortalRevisionIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
}
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"202": {
"description": "Request to update developer portal revision was accepted."
},
"200": {
"description": "Developer portal revision was successfully updated.",
"schema": {
"$ref": "./definitions.json#/definitions/PortalRevisionContract"
},
"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-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
}
}
}
},
"definitions": {},
"parameters": {}
}
Loading