Microsoft Azure API Management Documentation API

openapi: 3.2.0
info:
  title: ApiManagementClient Documentation API
  description: Use these REST APIs for performing operations on Documentation entity.
  version: '2024-05-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Documentation
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations
  : get:
      tags:
      - Documentation
      operationId: Documentation_ListByService
      description: Lists all Documentations of the API Management service instance.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - name: $filter
        in: query
        required: false
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | eq |  contains |</br>'
        schema:
          type: string
      - $ref: '#/components/parameters/TopQueryParameter'
      - $ref: '#/components/parameters/SkipQueryParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Paged Result response of Documentations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentationCollection'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: ./definitions.json#/definitions/DocumentationContract
      summary: Documentation list by service
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  : head:
      tags:
      - Documentation
      operationId: Documentation_GetEntityTag
      description: Gets the entity state (Etag) version of the Documentation by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/DocumentationIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Operation completed successfully.
          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:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Documentation get entity tag
      x-summary-source: derived
    get:
      tags:
      - Documentation
      operationId: Documentation_Get
      description: Gets the details of the Documentation specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/DocumentationIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The response body contains the specified Documentation entity.
          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:
                $ref: '#/components/schemas/DocumentationContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Documentation get
      x-summary-source: derived
    put:
      tags:
      - Documentation
      operationId: Documentation_CreateOrUpdate
      description: Creates a new Documentation or updates an existing one.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/DocumentationIdParameter'
      - $ref: '#/components/parameters/IfMatchOptionalParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '201':
          description: Documentation 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:
                $ref: '#/components/schemas/DocumentationContract'
        '200':
          description: Documentation was successfully updated.
          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:
                $ref: '#/components/schemas/DocumentationContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentationContract'
        description: Create parameters.
        required: true
      summary: Documentation create or update
      x-summary-source: derived
    patch:
      tags:
      - Documentation
      operationId: Documentation_Update
      description: Updates the details of the Documentation for an API specified by its identifier.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/DocumentationIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Documentation was successfully updated.
          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:
                $ref: '#/components/schemas/DocumentationContract'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentationUpdateContract'
        description: Documentation Update parameters.
        required: true
      summary: Documentation update
      x-summary-source: derived
    delete:
      tags:
      - Documentation
      operationId: Documentation_Delete
      description: Deletes the specified Documentation from an API.
      parameters:
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ServiceNameParameter'
      - $ref: '#/components/parameters/DocumentationIdParameter'
      - $ref: '#/components/parameters/IfMatchRequiredParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Documentation successfully removed
        '204':
          description: Documentation successfully removed by previous request or does not exist
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Documentation delete
      x-summary-source: derived
components:
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    TopQueryParameter:
      name: $top
      in: query
      required: false
      description: Number of records to return.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        minimum: 1
    ServiceNameParameter:
      name: serviceName
      in: path
      required: true
      description: The name of the API Management service.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 50
        minLength: 1
        pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
    SkipQueryParameter:
      name: $skip
      in: query
      required: false
      description: Number of records to skip.
      x-ms-parameter-location: method
      schema:
        type: integer
        format: int32
        minimum: 0
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    DocumentationIdParameter:
      name: documentationId
      in: path
      required: true
      description: Documentation identifier. Must be unique in the current API Management service instance.
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 256
        minLength: 1
        pattern: ^[^*#&+:<>?]+$
    IfMatchRequiredParameter:
      name: If-Match
      in: header
      required: true
      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.
      x-ms-parameter-location: method
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    IfMatchOptionalParameter:
      name: If-Match
      in: header
      required: false
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    DocumentationContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/DocumentationContractProperties'
          description: Markdown Documentation details.
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
      description: Markdown documentation details.
    DocumentationCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/DocumentationContract'
          x-ms-identifiers:
          - name
          description: Page values.
          readOnly: true
        nextLink:
          type: string
          description: Next page link if any.
          readOnly: true
      description: Paged Documentation list representation.
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    DocumentationUpdateContract:
      type: object
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/DocumentationContractProperties'
          description: Markdown Documentation details.
      description: Documentation update contract details.
    ProxyResource:
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      type: object
      allOf:
      - $ref: '#/components/schemas/Resource'
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.