openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 8.72 kB
JSON
{"openapi":"3.0.0","info":{"title":"PolicyMetadataClient","version":"2019-10-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/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyMetadata.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"policyinsights-policyMetadata","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.PolicyInsights/policyMetadata":{"get":{"description":"Get a list of the policy metadata resources.","operationId":"PolicyMetadata_List","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/topParameter"}],"responses":{"200":{"description":"Policy metadata resource collection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyMetadataCollection"},"examples":{"Get collection of policy metadata resources":{"$ref":"#/components/examples/Get_collection_of_policy_metadata_resources"},"Get collection of policy metadata resources using top query parameter":{"$ref":"#/components/examples/Get_collection_of_policy_metadata_resources_using_top_query_parameter"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.PolicyInsights/policyMetadata/{resourceName}":{"get":{"description":"Get policy metadata resource.","operationId":"PolicyMetadata_GetResource","parameters":[{"$ref":"#/components/parameters/resourceNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"Policy metadata resource definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyMetadata"},"examples":{"Get a single policy metadata resource":{"$ref":"#/components/examples/Get_a_single_policy_metadata_resource"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_collection_of_policy_metadata_resources":{"value":{"value":[{"id":"/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2","name":"NIST_SP_800-53_R4_AC-2","properties":{"additionalContentUrl":"https://aka.ms/NIST_SP_800-53_R4_AC-2","category":"Access control","metadata":{},"metadataId":"NIST SP 800-53 R4 AC-2","owner":"Shared","title":"Account Management"},"type":"Microsoft.PolicyInsights/policyMetadata"}]}},"Get_collection_of_policy_metadata_resources_using_top_query_parameter":{"value":{"value":[{"id":"/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2","name":"NIST_SP_800-53_R4_AC-2","properties":{"additionalContentUrl":"https://aka.ms/NIST_SP_800-53_R4_AC-2","category":"Access control","metadata":{},"metadataId":"NIST SP 800-53 R4 AC-2","owner":"Shared","title":"Account Management"},"type":"Microsoft.PolicyInsights/policyMetadata"}]}},"Get_a_single_policy_metadata_resource":{"value":{"id":"/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2","name":"NIST_SP_800-53_R4_AC-2","properties":{"additionalContentUrl":"https://aka.ms/NIST_SP_800-53_R4_AC-2","category":"Access control","description":"Description of NIST SP 800-53 R4 AC-2","metadata":{},"metadataId":"NIST SP 800-53 R4 AC-2","owner":"Shared","requirements":"List the requirements for NIST SP 800-53 R4 AC-2","title":"Account Management"},"type":"Microsoft.PolicyInsights/policyMetadata"}}},"parameters":{"apiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get collection of policy metadata resources":{"value":"2019-10-01"},"Get collection of policy metadata resources using top query parameter":{"value":"2019-10-01"},"Get a single policy metadata resource":{"value":"2019-10-01"}}},"resourceNameParameter":{"description":"The name of the policy metadata resource.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"Get a single policy metadata resource":{"value":"NIST_SP_800-53_R4_AC-2"}}},"topParameter":{"description":"Maximum number of records to return.","in":"query","name":"$top","required":false,"x-ms-client-name":"Top","x-ms-parameter-grouping":{"name":"QueryOptions"},"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0},"examples":{"Get collection of policy metadata resources using top query parameter":{"value":1}}}},"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"}}}}},"schemas":{"ErrorDefinition":{"description":"Error definition.","properties":{"additionalInfo":{"description":"Additional scenario specific error details.","items":{"$ref":"#/components/schemas/TypedErrorInfo"},"readOnly":true,"type":"array"},"code":{"description":"Service specific error code which serves as the substatus for the HTTP error code.","readOnly":true,"type":"string"},"details":{"description":"Internal error details.","items":{"$ref":"#/components/schemas/ErrorDefinition"},"readOnly":true,"type":"array"},"message":{"description":"Description of the error.","readOnly":true,"type":"string"},"target":{"description":"The target of the error.","readOnly":true,"type":"string"}}},"ErrorResponse":{"description":"Error response.","properties":{"error":{"$ref":"#/components/schemas/ErrorDefinition"}}},"PolicyMetadata":{"description":"Policy metadata resource definition.","properties":{"id":{"description":"The ID of the policy metadata.","readOnly":true,"type":"string"},"name":{"description":"The name of the policy metadata.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/PolicyMetadataProperties"},"type":{"description":"The type of the policy metadata.","readOnly":true,"type":"string"}}},"PolicyMetadataCollection":{"description":"Collection of policy metadata resources.","properties":{"nextLink":{"description":"The URL to get the next set of results.","readOnly":true,"type":"string"},"value":{"description":"Array of policy metadata definitions.","items":{"$ref":"#/components/schemas/SlimPolicyMetadata"},"readOnly":true,"type":"array"}}},"PolicyMetadataProperties":{"allOf":[{"$ref":"#/components/schemas/PolicyMetadataSlimProperties"}],"description":"The properties of the policy metadata.","properties":{"description":{"description":"The description of the policy metadata.","readOnly":true,"type":"string"},"requirements":{"description":"The requirements of the policy metadata.","readOnly":true,"type":"string"}}},"PolicyMetadataSlimProperties":{"description":"The properties of the policy metadata, excluding properties containing large strings","properties":{"additionalContentUrl":{"description":"Url for getting additional content about the resource metadata.","readOnly":true,"type":"string"},"category":{"description":"The category of the policy metadata.","readOnly":true,"type":"string"},"metadata":{"description":"Additional metadata.","readOnly":true,"type":"object"},"metadataId":{"description":"The policy metadata identifier.","readOnly":true,"type":"string"},"owner":{"description":"The owner of the policy metadata.","readOnly":true,"type":"string"},"title":{"description":"The title of the policy metadata.","readOnly":true,"type":"string"}}},"SlimPolicyMetadata":{"description":"Slim version of policy metadata resource definition, excluding properties with large strings","properties":{"id":{"description":"The ID of the policy metadata.","readOnly":true,"type":"string"},"name":{"description":"The name of the policy metadata.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/PolicyMetadataSlimProperties"},"type":{"description":"The type of the policy metadata.","readOnly":true,"type":"string"}}},"TypedErrorInfo":{"description":"Scenario specific error details.","properties":{"info":{"description":"The scenario specific error details.","readOnly":true},"type":{"description":"The type of included error details.","readOnly":true,"type":"string"}}}}}}