swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ApiSchema API
schemes:
- https
tags:
- name: ApiSchema
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas
  : get:
      tags:
      - ApiSchema
      operationId: microsoftAzureWorkspaceapischemaListbyapi
      description: Get the schema configuration at the API level.
      x-ms-examples:
        ApiManagementListWorkspaceApiSchemas:
          $ref: ./examples/ApiManagementListWorkspaceApiSchemas.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter
      - name: $filter
        in: query
        required: false
        type: string
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>'
      - $ref: ./apimanagement.json#/parameters/TopQueryParameter
      - $ref: ./apimanagement.json#/parameters/SkipQueryParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Apis Schema Collection.
          schema:
            $ref: ./definitions.json#/definitions/SchemaCollection
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: ./definitions.json#/definitions/SchemaContract
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Schemas
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/schemas/{schemaId}
  : head:
      tags:
      - ApiSchema
      operationId: microsoftAzureWorkspaceapischemaGetentitytag
      description: Gets the entity state (Etag) version of the schema specified by its identifier.
      x-ms-examples:
        ApiManagementHeadWorkspaceApiSchema:
          $ref: ./examples/ApiManagementHeadWorkspaceApiSchema.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter
      - $ref: ./apimanagement.json#/parameters/SchemaIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Specified schema entity exists and 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.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Schemas Schemaid
    get:
      tags:
      - ApiSchema
      operationId: microsoftAzureWorkspaceapischemaGet
      description: Get the schema configuration at the API level.
      x-ms-examples:
        ApiManagementGetWorkspaceApiSchema:
          $ref: ./examples/ApiManagementGetWorkspaceApiSchema.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter
      - $ref: ./apimanagement.json#/parameters/SchemaIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Api Schema information.
          schema:
            $ref: ./definitions.json#/definitions/SchemaContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Schemas Schemaid
    put:
      tags:
      - ApiSchema
      operationId: microsoftAzureWorkspaceapischemaCreateorupdate
      description: Creates or updates schema configuration for the API.
      x-ms-examples:
        ApiManagementCreateWorkspaceApiSchema:
          $ref: ./examples/ApiManagementCreateWorkspaceApiSchema.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter
      - $ref: ./apimanagement.json#/parameters/SchemaIdParameter
      - name: parameters
        in: body
        required: true
        schema:
          $ref: ./definitions.json#/definitions/SchemaContract
        description: The schema contents to apply.
      - $ref: ./apimanagement.json#/parameters/IfMatchOptionalParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Api schema configuration of the tenant was successfully updated.
          schema:
            $ref: ./definitions.json#/definitions/SchemaContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        '201':
          description: Api schema configuration was successfully created.
          schema:
            $ref: ./definitions.json#/definitions/SchemaContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Schemas Schemaid
    delete:
      tags:
      - ApiSchema
      operationId: microsoftAzureWorkspaceapischemaDelete
      description: Deletes the schema configuration at the Api.
      x-ms-examples:
        ApiManagementDeleteWorkspaceApiSchema:
          $ref: ./examples/ApiManagementDeleteWorkspaceApiSchema.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/ApiIdRevParameter
      - $ref: ./apimanagement.json#/parameters/SchemaIdParameter
      - name: force
        in: query
        required: false
        type: boolean
        description: If true removes all references to the schema before deleting it.
      - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Successfully deleted the schema configuration at the API level.
        '204':
          description: Successfully deleted the schema configuration at the API level.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Schemas Schemaid
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'