openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 28.1 kB

JSON

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on Global Policies in Azure API Management deployment.","title":"ApiManagementClient","version":"2019-01-01","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/stable/2019-01-01/apimpolicies.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimpolicies","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies":{"get":{"description":"Lists all the Global Policy definitions of the Api Management service.","operationId":"Policy_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListPolicies":{"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":{"ApiManagementListPolicies":{"value":"apimService1"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListPolicies":{"value":"2019-01-01"}}},{"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":{"ApiManagementListPolicies":{"value":"subid"}}}],"responses":{"200":{"description":"Returns an array of Policy Contracts.","content":{"application/json":{"schema":{"description":"The response of the list policy operation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Policy Contract value.","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 Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"type":"array"}}},"examples":{"ApiManagementListPolicies":{"$ref":"#/components/examples/ApiManagementListPolicies"}}}}},"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":["Policy"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/{policyId}":{"delete":{"description":"Deletes the global policy configuration of the Api Management Service.","operationId":"Policy_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeletePolicy":{"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":{"ApiManagementDeletePolicy":{"value":"apimService1"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementDeletePolicy":{"value":"policy"}}},{"description":"ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeletePolicy":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeletePolicy":{"value":"2019-01-01"}}},{"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":{"ApiManagementDeletePolicy":{"value":"subid"}}}],"responses":{"200":{"description":"Policy was successfully removed"},"204":{"description":"Policy successfully removed by previous request or does not exist"},"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":["Policy"]},"get":{"description":"Get the Global policy definition of the Api Management service.","operationId":"Policy_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetPolicy":{"value":"rg1"},"ApiManagementGetPolicyFormat":{"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":{"ApiManagementGetPolicy":{"value":"apimService1"},"ApiManagementGetPolicyFormat":{"value":"apimService1"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementGetPolicy":{"value":"policy"},"ApiManagementGetPolicyFormat":{"value":"policy"}}},{"description":"Policy Export Format.","in":"query","name":"format","required":false,"x-ms-enum":{"modelAsString":true,"name":"PolicyExportFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"}]},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["xml","rawxml"],"default":"xml"},"examples":{"ApiManagementGetPolicyFormat":{"value":"rawxml"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetPolicy":{"value":"2019-01-01"},"ApiManagementGetPolicyFormat":{"value":"2019-01-01"}}},{"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":{"ApiManagementGetPolicy":{"value":"subid"},"ApiManagementGetPolicyFormat":{"value":"subid"}}}],"responses":{"200":{"description":"Get the Global policy definition of the Api Management service.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"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 Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementGetPolicy":{"$ref":"#/components/examples/ApiManagementGetPolicy"},"ApiManagementGetPolicyFormat":{"$ref":"#/components/examples/ApiManagementGetPolicyFormat"}}}}},"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":["Policy"]},"head":{"description":"Gets the entity state (Etag) version of the Global policy definition in the Api Management service.","operationId":"Policy_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadPolicy":{"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":{"ApiManagementHeadPolicy":{"value":"apimService1"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementHeadPolicy":{"value":"policy"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadPolicy":{"value":"2019-01-01"}}},{"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":{"ApiManagementHeadPolicy":{"value":"subid"}}}],"responses":{"200":{"description":"The 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.","schema":{"type":"string"}}}},"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":["Policy"]},"put":{"description":"Creates or updates the global policy configuration of the Api Management service.","operationId":"Policy_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreatePolicy":{"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":{"ApiManagementCreatePolicy":{"value":"apimService1"}}},{"description":"The identifier of the Policy.","in":"path","name":"policyId","required":true,"x-ms-enum":{"modelAsString":true,"name":"PolicyIdName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["policy"]},"examples":{"ApiManagementCreatePolicy":{"value":"policy"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreatePolicy":{"value":"2019-01-01"}}},{"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":{"ApiManagementCreatePolicy":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"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 Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}}}},"description":"The policy contents to apply.","required":true},"responses":{"200":{"description":"Global policy configuration of the Api Management service was successfully updated.","headers":{"ETag":{"description":"Current entity state version","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"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 Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementCreatePolicy":{"$ref":"#/components/examples/ApiManagementCreatePolicy"}}}}},"201":{"description":"Global policy configuration was successfully created.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"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 Contract details.","properties":{"properties":{"description":"Policy contract Properties.","properties":{"format":{"default":"xml","description":"Format of the policyContent.","enum":["xml","xml-link","rawxml","rawxml-link"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PolicyContentFormat","values":[{"description":"The contents are inline and Content type is an XML document.","value":"xml"},{"description":"The policy XML document is hosted on a http endpoint accessible from the API Management service.","value":"xml-link"},{"description":"The contents are inline and Content type is a non XML encoded policy document.","value":"rawxml"},{"description":"The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.","value":"rawxml-link"}]}},"value":{"description":"Contents of the Policy as defined by the format.","type":"string"}},"required":["value"]}}},"examples":{"ApiManagementCreatePolicy":{"$ref":"#/components/examples/ApiManagementCreatePolicy"}}}}},"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":["Policy"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListPolicies":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy","name":"policy","properties":{"value":"\r\n<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"},"type":"Microsoft.ApiManagement/service/policies"}]}},"ApiManagementGetPolicy":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy","name":"policy","properties":{"value":"\r\n<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"},"type":"Microsoft.ApiManagement/service/policies"}},"ApiManagementGetPolicyFormat":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy","name":"policy","properties":{"format":"rawxml","value":"\r\n<policies>\r\n\t<inbound>\r\n\t\t<set-header name=\"correlationid\" exists-action=\"skip\">\r\n\t\t\t<value>@{\n var guidBinary = new byte[16];\n Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);\n long time = DateTime.Now.Ticks;\n byte[] bytes = new byte[6];\n unchecked\n {\n bytes[5] = (byte)(time >> 40);\n bytes[4] = (byte)(time >> 32);\n bytes[3] = (byte)(time >> 24);\n bytes[2] = (byte)(time >> 16);\n bytes[1] = (byte)(time >> 8);\n bytes[0] = (byte)(time);\n }\n Array.Copy(bytes, 0, guidBinary, 10, 6);\n return new Guid(guidBinary).ToString();\n }\n </value>\r\n\t\t</set-header>\r\n\t</inbound>\r\n\t<backend>\r\n\t\t<forward-request />\r\n\t</backend>\r\n\t<outbound />\r\n\t<on-error />\r\n</policies>"},"type":"Microsoft.ApiManagement/service/policies"}},"ApiManagementCreatePolicy":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy","name":"policy","properties":{"value":"<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"},"type":"Microsoft.ApiManagement/service/policies"}}},"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"}}}}}}}