Microsoft Azure Document:translate API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Document:translate API
tags:
- name: Document:translate
paths:
  /document:translate:
    post:
      operationId: microsoftAzureDocumenttranslate
      description: API to translate a document.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/components/parameters/DocumentTranslateContent.sourceLanguage'
      - $ref: '#/components/parameters/DocumentTranslateContent.targetLanguage'
      - $ref: '#/components/parameters/DocumentTranslateContent.category'
      - $ref: '#/components/parameters/DocumentTranslateContent.allowFallback'
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      - $ref: '#/components/parameters/DocumentTranslateContent.document'
      - $ref: '#/components/parameters/DocumentTranslateContent.glossary'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      x-ms-examples:
        Document Translate:
          $ref: ./examples/DocumentTranslate_MaximumSet_Gen.json
      summary: Microsoft Azure Post Document:translate
      tags:
      - Document:translate
components:
  parameters:
    DocumentTranslateContent.document:
      name: document
      in: formData
      description: Document to be translated in the form
      required: true
      type: string
      x-ms-parameter-location: method
      format: binary
    DocumentTranslateContent.category:
      name: category
      in: query
      description: "A string specifying the category (domain) of the translation. This parameter is used to get translations \n    from a customized system built with Custom Translator. Add the Category ID from your Custom Translator \n    project details to this parameter to use your deployed customized system. Default value is: general."
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
        default: general
    Azure.Core.ClientRequestIdHeader:
      name: x-ms-client-request-id
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: clientRequestId
      schema:
        type: string
        format: uuid
    DocumentTranslateContent.glossary:
      name: glossary
      in: formData
      description: Glossary / translation memory will be used during translation in the form.
      required: false
      type: array
      items:
        type: string
        format: binary
      x-ms-parameter-location: method
    DocumentTranslateContent.sourceLanguage:
      name: sourceLanguage
      in: query
      description: 'Specifies source language of the input document.

        If this parameter isn''t specified, automatic language detection is applied to determine the source language.

        For example if the source document is written in English, then use sourceLanguage=en'
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    DocumentTranslateContent.targetLanguage:
      name: targetLanguage
      in: query
      description: 'Specifies the language of the output document.

        The target language must be one of the supported languages included in the translation scope.

        For example if you want to translate the document in German language, then use targetLanguage=de'
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
    DocumentTranslateContent.allowFallback:
      name: allowFallback
      in: query
      description: "Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. \n    Possible values are: true (default) or false."
      required: false
      x-ms-parameter-location: method
      schema:
        type: boolean
  schemas:
    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: '#/components/schemas/Azure.Core.Foundations.Error'
          x-ms-identifiers: []
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
    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: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'