openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 5.7 kB
JSON
{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing retrieving a collection of policy snippets available in Azure API Management deployment.","title":"ApiManagementClient","version":"2019-12-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimpolicydescriptions.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"apimanagement-apimpolicydescriptions","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions":{"get":{"description":"Lists all policy descriptions.","operationId":"PolicyDescription_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListPolicyDescriptions":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListPolicyDescriptions":{"value":"apimService1"}}},{"description":"Policy scope.","in":"query","name":"scope","required":false,"x-ms-enum":{"modelAsString":false,"name":"PolicyScopeContract"},"schema":{"type":"string","enum":["Tenant","Product","Api","Operation","All"]},"examples":{"ApiManagementListPolicyDescriptions":{"value":"Api"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListPolicyDescriptions":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListPolicyDescriptions":{"value":"subid"}}}],"responses":{"200":{"description":"Returns an array of policy descriptions.","content":{"application/json":{"schema":{"description":"Descriptions of APIM policies.","properties":{"count":{"description":"Total record count number.","format":"int64","type":"integer"},"value":{"description":"Descriptions of APIM policies.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Policy description details.","properties":{"properties":{"description":"Policy description properties.","properties":{"description":{"description":"Policy description.","readOnly":true,"type":"string"},"scope":{"description":"Binary OR value of the Snippet scope.","readOnly":true,"type":"integer"}}}}},"type":"array"}}},"examples":{"ApiManagementListPolicyDescriptions":{"$ref":"#/components/examples/ApiManagementListPolicyDescriptions"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["PolicyDescription"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListPolicyDescriptions":{"value":{"count":2,"value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic","name":"authentication-basic","properties":{"description":"Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.","scope":268435471},"type":"Microsoft.ApiManagement/service/policyDescriptions"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate","name":"authentication-certificate","properties":{"description":"Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.","scope":268435471},"type":"Microsoft.ApiManagement/service/policyDescriptions"}]}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}}}}