swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BaseModel API
schemes:
- https
tags:
- name: BaseModel
paths:
  /basemodels:
    get:
      tags:
      - BaseModel
      description: Gets a list of base models.
      operationId: microsoftAzureBasemodelsList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/QueryApiVersion'
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              $ref: '#/definitions/BaseModel'
        default:
          description: An error occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Get base models:
          $ref: ./examples/get_base_models.json
      summary: Microsoft Azure Get Basemodels
definitions:
  ModelCapability:
    description: Model capability
    enum:
    - PersonalVoice
    type: string
    x-ms-enum:
      name: ModelCapability
      modelAsString: true
  ErrorResponse:
    description: Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
  ErrorCode:
    description: Top-level error code
    enum:
    - BadRequest
    - BadArgument
    - Unauthorized
    - Forbidden
    - NotFound
    - UnsupportedMediaType
    - TooManyRequests
    - InternalServerError
    - ServiceUnavailable
    type: string
    x-ms-enum:
      name: ErrorCode
      modelAsString: true
  BaseModel:
    description: Base model
    required:
    - name
    - releaseDateTime
    type: object
    properties:
      name:
        minLength: 1
        type: string
      description:
        type: string
      releaseDateTime:
        description: The stamp when the base model was released. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
        format: date-time
        type: string
      expirationDateTime:
        description: The timestamp when TTS service will stop serving this base model. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
        format: date-time
        type: string
      capabilities:
        description: Capabilities of base model
        type: array
        items:
          $ref: '#/definitions/ModelCapability'
  InnerError:
    description: Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
    type: object
    properties:
      code:
        description: Detailed error code to help diagnostic.
        type: string
      target:
        description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
        type: string
      message:
        description: Detailed error message.
        type: string
      innererror:
        $ref: '#/definitions/InnerError'
  Error:
    description: Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.
    required:
    - code
    - message
    type: object
    properties:
      code:
        $ref: '#/definitions/ErrorCode'
      target:
        description: The source of the error. For example it would be "model" or "model id" in case of invalid model.
        type: string
      message:
        description: Top-level error message.
        type: string
      details:
        description: Additional supportive details regarding the error and/or expected policies.
        type: array
        items:
          $ref: '#/definitions/Error'
      innererror:
        $ref: '#/definitions/InnerError'
parameters:
  QueryApiVersion:
    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'