Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Updated API Swagger for Microsoft.* Created by GitHub Action #5

Open
wants to merge 1 commit into
base: sync-swagger-specs-demo
Choose a base branch
from
Open

Updated API Swagger for Microsoft.* Created by GitHub Action #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2,012 changes: 1,388 additions & 624 deletions App_Data/SwaggerSpecs/Microsoft.Advisor/advisor.json
View file
Open in desktop

Large diffs are not rendered by default.

1,089 changes: 1,029 additions & 60 deletions App_Data/SwaggerSpecs/Microsoft.AnalysisServices/analysisservices.json
View file
Open in desktop

Large diffs are not rendered by default.

1,142 changes: 614 additions & 528 deletions App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimanagement.json
View file
Open in desktop

Large diffs are not rendered by default.

3,417 changes: 1,590 additions & 1,827 deletions App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimapis.json
View file
Open in desktop

Large diffs are not rendered by default.

439 changes: 92 additions & 347 deletions App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimauthorizationservers.json
View file
Open in desktop

Large diffs are not rendered by default.

444 changes: 52 additions & 392 deletions App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimbackends.json
View file
Open in desktop

Large diffs are not rendered by default.

206 changes: 96 additions & 110 deletions App_Data/SwaggerSpecs/Microsoft.ApiManagement/apimcertificates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "ApiManagementClient",
"description": "Use these REST APIs for performing operations on Certificate entity in your Azure API Management deployment. Certificates can be used to setup mutual authentication with your Backend in API Management. For more information refer to [How to secure backend using Mutual Auth Certificate](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates).",
"version": "2018-01-01"
"version": "2021-08-01"
},
"host": "management.azure.com",
"schemes": [
Expand Down Expand Up @@ -37,7 +37,7 @@
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates": {
"get": {
"tags": [
"Certificates"
"Certificate"
],
"operationId": "Certificate_ListByService",
"description": "Lists a collection of all certificates in the specified service instance.",
Expand All @@ -58,14 +58,21 @@
"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| subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| expirationDate | ge, le, eq, ne, gt, lt | N/A |"
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| expirationDate | filter | ge, le, eq, ne, gt, lt | |</br>"
},
{
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SkipQueryParameter"
},
{
"name": "isKeyVaultRefreshFailed",
"in": "query",
"required": false,
"type": "boolean",
"description": "When set to true, the response contains only certificates entities which failed refresh."
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
Expand All @@ -77,7 +84,7 @@
"200": {
"description": "Returns a collection of Certificate entity.",
"schema": {
"$ref": "#/definitions/CertificateCollection"
"$ref": "./definitions.json#/definitions/CertificateCollection"
}
},
"default": {
Expand All @@ -90,13 +97,13 @@
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "#/definitions/CertificateContract"
"x-ms-odata": "./definitions.json#/definitions/CertificateContract"
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}": {
"head": {
"tags": [
"Certificates"
"Certificate"
],
"operationId": "Certificate_GetEntityTag",
"description": "Gets the entity state (Etag) version of the certificate specified by its identifier.",
Expand All @@ -113,7 +120,7 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "#/parameters/CertificateIdParameter"
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -142,13 +149,16 @@
},
"get": {
"tags": [
"Certificates"
"Certificate"
],
"operationId": "Certificate_Get",
"description": "Gets the details of the certificate specified by its identifier.",
"x-ms-examples": {
"ApiManagementGetCertificate": {
"$ref": "./examples/ApiManagementGetCertificate.json"
},
"ApiManagementGetCertificateWithKeyVault": {
"$ref": "./examples/ApiManagementGetCertificateWithKeyVault.json"
}
},
"parameters": [
Expand All @@ -159,7 +169,7 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "#/parameters/CertificateIdParameter"
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
Expand All @@ -172,7 +182,7 @@
"200": {
"description": "The response body contains the specified Certificate entity.",
"schema": {
"$ref": "#/definitions/CertificateContract"
"$ref": "./definitions.json#/definitions/CertificateContract"
},
"headers": {
"ETag": {
Expand All @@ -191,7 +201,7 @@
},
"put": {
"tags": [
"Certificates"
"Certificate"
],
"operationId": "Certificate_CreateOrUpdate",
"description": "Creates or updates the certificate being used for authentication with the backend.",
Expand All @@ -202,6 +212,9 @@
"x-ms-examples": {
"ApiManagementCreateCertificate": {
"$ref": "./examples/ApiManagementCreateCertificate.json"
},
"ApiManagementCreateCertificateWithKeyVault": {
"$ref": "./examples/ApiManagementCreateCertificateWithKeyVault.json"
}
},
"parameters": [
Expand All @@ -212,14 +225,14 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "#/parameters/CertificateIdParameter"
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CertificateCreateOrUpdateParameters"
"$ref": "./definitions.json#/definitions/CertificateCreateOrUpdateParameters"
},
"description": "Create or Update parameters."
},
Expand All @@ -236,14 +249,26 @@
"responses": {
"201": {
"description": "The new certificate was successfully added.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/CertificateContract"
"$ref": "./definitions.json#/definitions/CertificateContract"
}
},
"200": {
"description": "The certificate details were successfully updated.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/CertificateContract"
"$ref": "./definitions.json#/definitions/CertificateContract"
}
},
"default": {
Expand All @@ -256,7 +281,7 @@
},
"delete": {
"tags": [
"Certificates"
"Certificate"
],
"operationId": "Certificate_Delete",
"description": "Deletes specific certificate.",
Expand All @@ -273,7 +298,7 @@
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "#/parameters/CertificateIdParameter"
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
Expand All @@ -300,102 +325,63 @@
}
}
}
}
},
"definitions": {
"CertificateCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/CertificateContract"
},
"description": "Page values."
},
"nextLink": {
"type": "string",
"description": "Next page link if any."
}
},
"description": "Paged Certificates list representation."
},
"CertificateContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/CertificateContractProperties",
"description": "Certificate properties details."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "Certificate details."
},
"CertificateContractProperties": {
"properties": {
"subject": {
"type": "string",
"description": "Subject attribute of the certificate."
},
"thumbprint": {
"type": "string",
"description": "Thumbprint of the certificate."
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}/refreshSecret": {
"post": {
"tags": [
"Certificate"
],
"operationId": "Certificate_RefreshSecret",
"description": "From KeyVault, Refresh the certificate being used for authentication with the backend.",
"externalDocs": {
"description": "How to secure back-end services using client certificate authentication in Azure API Management",
"url": "https://azure.microsoft.com/en-us/documentation/articles/api-management-howto-mutual-certificates/"
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n"
}
},
"required": [
"subject",
"thumbprint",
"expirationDate"
],
"description": "Properties of the Certificate contract."
},
"CertificateCreateOrUpdateParameters": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/CertificateCreateOrUpdateProperties",
"description": "Certificate create or update properties details."
}
},
"description": "Certificate create or update details."
},
"CertificateCreateOrUpdateProperties": {
"properties": {
"data": {
"type": "string",
"description": "Base 64 encoded certificate using the application/x-pkcs12 representation."
"x-ms-examples": {
"ApiManagementRefreshCertificate": {
"$ref": "./examples/ApiManagementRefreshCertificate.json"
}
},
"password": {
"type": "string",
"description": "Password for the Certificate"
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The certificate details were successfully updated.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "./definitions.json#/definitions/CertificateContract"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"required": [
"data",
"password"
],
"description": "Parameters supplied to the CreateOrUpdate certificate operation."
}
}
},
"parameters": {
"CertificateIdParameter": {
"name": "certificateId",
"in": "path",
"required": true,
"type": "string",
"description": "Identifier of the certificate entity. Must be unique in the current API Management service instance.",
"minLength": 1,
"maxLength": 80,
"pattern": "(^[\\w]+$)|(^[\\w][\\w\\-]+[\\w]$)",
"x-ms-parameter-location": "method"
}
}
}
"definitions": {},
"parameters": {}
}
Loading