api_common.yaml

components:
  parameters:
      accountUid:
        name: accountUid
        in: path
        schema:
          type: string
        required: true
        description: The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

      projectId:
        name: projectId
        in: path
        required: true
        schema:
          type: string
        description: A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.

      localeId:
        name: localeId
        in: path
        required: true
        schema:
          type: string
        description: A valid Smartling Locale ID.

  requestBodies:

      sourceLocaleId:
        type: object
        properties:
          sourceLocaleId:
            type: string
            description: The locale identifier for the source locale of the project. This indicates the base locale for which content should be uploaded to the project.
            example: "en-US"

      hashcode:
        type: object
        properties:
          hashcode:
            type: string
            description: string hashcode
            example: "7191152182c69d9b72069ac1290fe24b"

  schemas:

    SuccessResponse:
      type: object
      required:
        - code
      properties:
        code:
          type: string
          enum:
            - SUCCESS
            - ACCEPTED
          description: Indicates whether the response was successful or what error has occurred.

    EmptyResponse:
      type: object
      required:
        - response
      properties:
        response:
          allOf:
            - $ref: '#/components/schemas/SuccessResponse'
            - properties:
                data:
                  description: Always null.
                  type: object
              type: object

    NotEmptyResponse:
      type: object
      required:
        - response
      properties:
        response:
          allOf:
            - $ref: '#/components/schemas/SuccessResponse'
            - properties:
                data:
                  properties:
                    message:
                      type: string
                  type: object
              type: object

    Error:
      type: object
      properties:
        key:
          example: general_error
          type: string
        message:
          example: Unexpected server error
          type: string
        details:
          example: {}
          type: object
      required:
        - key
        - message

    Error400Response:
      type: object
      properties:
        response:
          properties:
            code:
              description: >-
                Indicates whether the response was successful or what error has occurred.
              enum:
                - VALIDATION_ERROR
              type: string
            errors:
              items:
                $ref: '#/components/schemas/Error'
              type: array
          required:
            - code
            - errors
          type: object
      required:
        - response

    Error401Response:
      properties:
        response:
          properties:
            code:
              description: >-
                Indicates whether the response was successful or what error has occurred.
              enum:
                - AUTHENTICATION_ERROR
                - AUTHORIZATION_ERROR
              type: string
            errors:
              items:
                $ref: '#/components/schemas/Error'
              type: array
          required:
            - code
            - errors
          type: object
      required:
        - response
      type: object
    Error404Response:
      properties:
        response:
          properties:
            code:
              description: >-
                Indicates whether the response was successful or what error has occurred.
              enum:
                - NOT_FOUND_ERROR
              type: string
            errors:
              items:
                $ref: '#/components/schemas/Error'
              type: array
          required:
            - code
            - errors
          type: object
      required:
        - response
      type: object
    Error423Response:
      properties:
        response:
          properties:
            code:
              description: >-
                Indicates whether the response was successful or what error has occurred.
              enum:
                - RESOURCE_LOCKED
              type: string
            errors:
              items:
                $ref: '#/components/schemas/Error'
              type: array
          required:
            - code
            - errors
          type: object
      required:
        - response
      type: object
    Error429Response:
      properties:
        response:
          properties:
            code:
              description: >-
                Indicates whether the response was successful or what error has occurred.
              enum:
                - MAX_OPERATIONS_LIMIT_EXCEEDED
              type: string
            errors:
              items:
                $ref: '#/components/schemas/Error'
              type: array
          required:
            - code
            - errors
          type: object
      required:
        - response
      type: object
    Error500Response:
      properties:
        response:
          properties:
            code:
              description: >-
                Indicates whether the response was successful or what error has occurred.
              enum:
                - GENERAL_ERROR
                - MAINTENANCE_MODE_ERROR
              type: string
            errors:
              items:
                $ref: '#/components/schemas/Error'
              type: array
          required:
            - code
            - errors
          type: object
      required:
        - response
      type: object
  responses:
    Error400ResponseDefinition:
      description: Provided request parameters are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error400Response'
          examples:
            response:
              value:
                response:
                  code: VALIDATION_ERROR
                  errors:
                    - key: unknown.field
                      message: >-
                        The field unknown.parameter was not expected. Please
                        consult the documentation to verify the fields you are
                        submitting.
                      details: {}

    Error401ResponseDefinition:
      description: Provided credentials are not valid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error401Response'
          examples:
            response:
              value:
                response:
                  code: AUTHENTICATION_ERROR
                  errors:
                    - key: invalid_token
                      details: {}
                      message: Invalid token

    Error429ResponseDefinition:
      description: Too many simultaneous API requests.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error429Response'
          examples:
            response:
              value:
                response:
                  code: MAX_OPERATIONS_LIMIT_EXCEEDED
                  errors:
                    - key: too.many.requests
                      message: >-
                        The limit of 10 concurrent Smartling file API
                        operations for this project has been exceeded.

    Error500ResponseDefinition:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error500Response'