swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Apis API
schemes:
- https
tags:
- name: Apis
paths:
  /apis:
    get:
      operationId: microsoftAzureApisListall
      description: List a collection of APIs across workspaces.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedApiAll'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Apis_ListAll:
          $ref: ./examples/Apis_ListAll.json
      summary: Microsoft Azure Get Apis
      tags:
      - Apis
definitions:
  Api:
    type: object
    description: API resource model.
    properties:
      name:
        type: string
        description: Api identifier.
        maxLength: 50
      title:
        type: string
        description: The name of the API.
        maxLength: 50
      summary:
        type: string
        description: Short description of the API.
        maxLength: 200
      description:
        type: string
        description: The description of the API
        maxLength: 1000
      kind:
        $ref: '#/definitions/ApiKind'
        description: Kind of API. For example, REST or GraphQL.
      lifecycleStage:
        $ref: '#/definitions/LifecycleStage'
        description: Current lifecycle stage of the API.
        readOnly: true
      termsOfService:
        $ref: '#/definitions/TermsOfService'
        description: Terms of service for the API.
      license:
        $ref: '#/definitions/License'
        description: The license information for the API.
      externalDocumentation:
        type: array
        description: External documentation
        items:
          $ref: '#/definitions/ExternalDocumentation'
        x-ms-identifiers: []
      contacts:
        type: array
        description: Points of contact for the API.
        items:
          $ref: '#/definitions/Contact'
        x-ms-identifiers: []
      customProperties:
        type: object
        description: The custom metadata defined for API entities.
      lastUpdated:
        type: string
        format: date-time
        description: Last updated date and time.
        readOnly: true
    required:
    - name
    - title
    - kind
  LifecycleStage:
    type: string
    description: API Lifecycle Stage
    enum:
    - design
    - development
    - testing
    - preview
    - production
    - deprecated
    - retired
    x-ms-enum:
      name: LifecycleStage
      modelAsString: true
      values:
      - name: Design
        value: design
        description: API is in the design stage
      - name: Development
        value: development
        description: API is in the development stage
      - name: Testing
        value: testing
        description: API is in the testing stage
      - name: Preview
        value: preview
        description: API is in the preview stage
      - name: Production
        value: production
        description: API is in the production stage
      - name: Deprecated
        value: deprecated
        description: API is in the deprecated stage
      - name: Retired
        value: retired
        description: API is in the retired stage
  PagedApiAll:
    type: object
    description: Paged collection of API items across workspaces.
    properties:
      value:
        type: array
        description: The Api items on this page
        items:
          $ref: '#/definitions/Api'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  ApiKind:
    type: string
    description: API kind
    enum:
    - rest
    - graphql
    - grpc
    - soap
    - webhook
    - websocket
    x-ms-enum:
      name: ApiKind
      modelAsString: true
      values:
      - name: Rest
        value: rest
        description: REST API
      - name: Graphql
        value: graphql
        description: GraphQL API
      - name: Grpc
        value: grpc
        description: GRPC API
      - name: Soap
        value: soap
        description: SOAP API
      - name: Webhook
        value: webhook
        description: Webhook API
      - name: Websocket
        value: websocket
        description: Websocket API
  License:
    type: object
    description: API License Model
    properties:
      name:
        type: string
        description: Name of the license.
        maxLength: 50
      url:
        type: string
        format: uri
        description: URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
      identifier:
        type: string
        description: SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
        maxLength: 200
    required:
    - name
  TermsOfService:
    type: object
    description: API Terms of Service
    properties:
      url:
        type: string
        format: uri
        description: URL pointing to the terms of service.
    required:
    - url
  ExternalDocumentation:
    type: object
    description: Api External Documentation Model
    properties:
      title:
        type: string
        description: Title of the documentation.
        maxLength: 50
      description:
        type: string
        description: Description of the documentation.
        maxLength: 1000
      url:
        type: string
        format: uri
        description: URL pointing to the documentation.
    required:
    - title
    - description
    - url
  Contact:
    type: object
    description: API contact information
    properties:
      name:
        type: string
        description: Name of the contact.
        maxLength: 100
      url:
        type: string
        format: uri
        description: URL for the contact.
      email:
        type: string
        description: Email address for the contact.
        maxLength: 100
    required:
    - name
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  Azure.Core.MaxPageSizeQueryParameter:
    name: maxpagesize
    in: query
    description: The maximum number of result items per page.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  Azure.Core.SkipQueryParameter:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
  Azure.Core.TopQueryParameter:
    name: top
    in: query
    description: The number of result items to return.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'