openapi-directory/api/azure.com/apimanagement-apimissues.json

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

{"openapi":"3.0.0","info":{"description":"Use this REST API to get all the issues across an Azure Api Management service.","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/apimissues.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimissues","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues":{"get":{"description":"Lists a collection of issues in the specified service instance.","operationId":"Issue_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListIssues":{"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":{"ApiManagementListIssues":{"value":"apimService1"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq |     | </br>","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListIssues":{"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":{"ApiManagementListIssues":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Issue entities.","content":{"application/json":{"schema":{"description":"Paged Issue list representation.","properties":{"nextLink":{"description":"Next page link if any.","readOnly":true,"type":"string"},"value":{"description":"Issue values.","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":"Issue Contract details.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}},"required":["title","description","userId"]}}},"readOnly":true,"type":"array"}}},"examples":{"ApiManagementListIssues":{"$ref":"#/components/examples/ApiManagementListIssues"}}}}},"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":["Issue"],"x-ms-odata":"./definitions.json#/definitions/IssueContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues/{issueId}":{"get":{"description":"Gets API Management issue details","operationId":"Issue_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetIssue":{"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":{"ApiManagementGetIssue":{"value":"apimService1"}}},{"description":"Issue identifier. Must be unique in the current API Management service instance.","in":"path","name":"issueId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetIssue":{"value":"57d2ef278aa04f0ad01d6cdc"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetIssue":{"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":{"ApiManagementGetIssue":{"value":"subid"}}}],"responses":{"200":{"description":"Get the details of the issue.","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":"Issue Contract details.","properties":{"properties":{"allOf":[{"description":"Issue contract Base Properties.","properties":{"apiId":{"description":"A resource identifier for the API the issue was created for.","type":"string"},"createdDate":{"description":"Date and time when the issue was created.","format":"date-time","type":"string"},"state":{"description":"Status of the issue.","enum":["proposed","open","removed","resolved","closed"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"State","values":[{"description":"The issue is proposed.","value":"proposed"},{"description":"The issue is opened.","value":"open"},{"description":"The issue was removed.","value":"removed"},{"description":"The issue is now resolved.","value":"resolved"},{"description":"The issue was closed.","value":"closed"}]}}}}],"description":"Issue contract Properties.","properties":{"description":{"description":"Text describing the issue.","type":"string"},"title":{"description":"The issue title.","type":"string"},"userId":{"description":"A resource identifier for the user created the issue.","type":"string"}},"required":["title","description","userId"]}}},"examples":{"ApiManagementGetIssue":{"$ref":"#/components/examples/ApiManagementGetIssue"}}}}},"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":["Issue"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListIssues":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc","name":"57d2ef278aa04f0ad01d6cdc","properties":{"apiId":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a","createdDate":"2018-02-01T22:21:20.467Z","description":"New API issue description","state":"open","title":"New API issue","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/issues"}]}},"ApiManagementGetIssue":{"value":{"id":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc","name":"57d2ef278aa04f0ad01d6cdc","properties":{"apiId":"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a","createdDate":"2018-02-01T22:21:20.467Z","description":"New API issue description","state":"open","title":"New API issue","userId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"},"type":"Microsoft.ApiManagement/service/issues"}}},"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"}}}}}}}