swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Transliterate API
schemes:
- https
tags:
- name: Transliterate
paths:
  /transliterate:
    post:
      operationId: microsoftAzureTransliterate
      summary: Microsoft Azure Transliterate Text
      description: Transliterate Text
      parameters:
      - name: X-ClientTraceId
        in: header
        description: A client-generated GUID to uniquely identify the request.
        required: false
        type: string
        x-ms-client-name: clientTraceId
      - $ref: '#/parameters/TransliterateParameters.language'
      - $ref: '#/parameters/TransliterateParameters.fromScript'
      - $ref: '#/parameters/TransliterateParameters.toScript'
      - name: api-version
        in: query
        description: Mandatory API version parameter
        required: true
        type: string
        x-ms-client-name: apiVersion
      - name: requestBody
        in: body
        description: Defines the content of the request
        required: true
        schema:
          type: array
          items:
            $ref: '#/definitions/InputTextItem'
          x-ms-identifiers: []
      responses:
        '200':
          description: Response for the transliteration API.
          schema:
            type: array
            items:
              $ref: '#/definitions/TransliteratedText'
            x-ms-identifiers: []
          headers:
            X-RequestId:
              type: string
              description: Value generated by the service to identify the request. It is used for troubleshooting purposes.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            X-RequestId:
              type: string
              description: Value generated by the service to identify the request. It is used for troubleshooting purposes.
      x-ms-examples:
        Transliterate Text:
          $ref: ./examples/Transliterate_MaximumSet_Gen.json
        Transliterate Text with minimum properties:
          $ref: ./examples/Transliterate_MinimumSet_Gen.json
      tags:
      - Transliterate
definitions:
  ErrorResponse:
    type: object
    description: Representation of the Error Response from Translator Service.
    properties:
      error:
        $ref: '#/definitions/ErrorDetails'
        description: Error details.
    required:
    - error
  ErrorDetails:
    type: object
    description: Error details as returned by Translator Service.
    properties:
      code:
        type: integer
        format: int32
        description: Number identifier of the error.
      message:
        type: string
        description: Human readable error description.
    required:
    - code
    - message
  TransliteratedText:
    type: object
    description: Transliterated text element.
    properties:
      text:
        type: string
        description: A string which is the result of converting the input string to the output script.
      script:
        type: string
        description: A string specifying the script used in the output.
    required:
    - text
    - script
  InputTextItem:
    type: object
    description: Element containing the text for translation.
    properties:
      text:
        type: string
        description: Text to translate.
    required:
    - text
parameters:
  TransliterateParameters.toScript:
    name: toScript
    in: query
    description: "Specifies the output script. Look up supported languages using the transliteration scope, to find output \nscripts available for the selected combination of input language and input script."
    required: true
    type: string
    x-ms-parameter-location: method
  TransliterateParameters.fromScript:
    name: fromScript
    in: query
    description: 'Specifies the script used by the input text. Look up supported languages using the transliteration scope,

      to find input scripts available for the selected language.'
    required: true
    type: string
    x-ms-parameter-location: method
  TransliterateParameters.language:
    name: language
    in: query
    description: "Specifies the language of the text to convert from one script to another. \nPossible languages are listed in the transliteration scope obtained by querying the service \nfor its supported languages."
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'