swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Alterations API
schemes:
- https
tags:
- name: Alterations
paths:
  /alterations:
    get:
      tags:
      - Alterations
      summary: Microsoft Azure Download Alterations From Runtime
      operationId: microsoftAzureAlterationsGet
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: Alterations data.
          schema:
            $ref: '#/definitions/WordAlterationsDTO'
          x-nullable: true
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulGetAlts.json
      description: Needs a more full description created.
    put:
      tags:
      - Alterations
      summary: Microsoft Azure Replace Alterations Data
      operationId: microsoftAzureAlterationsReplace
      parameters:
      - $ref: '#/parameters/WordAlterations'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '204':
          description: HTTP 204 No Content.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulSetAlts.json
      description: Needs a more full description created.
  /alterations/{kbId}:
    get:
      tags:
      - Alterations
      summary: Microsoft Azure Download Alterations Per Knowledgebase Qnamaker Managed
      operationId: microsoftAzureAlterationsGetalterationsforkb
      parameters:
      - $ref: '#/parameters/KbId'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: Alterations data.
          schema:
            $ref: '#/definitions/WordAlterationsDTO'
          x-nullable: true
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulGetAltsForKb.json
      description: Needs a more full description created.
    put:
      tags:
      - Alterations
      summary: Microsoft Azure Replace Alterations Data Per Knowledgebase Qnamaker Managed
      operationId: microsoftAzureAlterationsReplacealterationsforkb
      parameters:
      - $ref: '#/parameters/KbId'
      - $ref: '#/parameters/WordAlterations'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '204':
          description: HTTP 204 No Content.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulSetAltsForKb.json
      description: Needs a more full description created.
definitions:
  WordAlterationsDTO:
    type: object
    description: Collection of word alterations.
    additionalProperties: false
    required:
    - wordAlterations
    properties:
      wordAlterations:
        type: array
        description: Collection of word alterations.
        maxLength: 10000
        items:
          $ref: '#/definitions/AlterationsDTO'
  ErrorResponse:
    type: object
    description: Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    additionalProperties: false
    properties:
      error:
        description: The error object.
        allOf:
        - $ref: '#/definitions/Error'
  ErrorCode:
    type: string
    description: Human readable error code.
    x-ms-enum:
      name: ErrorCodeType
      modelAsString: true
    enum:
    - BadArgument
    - Forbidden
    - NotFound
    - KbNotFound
    - Unauthorized
    - Unspecified
    - EndpointKeysError
    - QuotaExceeded
    - QnaRuntimeError
    - SKULimitExceeded
    - OperationNotFound
    - ServiceError
    - ValidationFailure
    - ExtractionFailure
  AlterationsDTO:
    type: object
    description: Collection of words that are synonyms.
    additionalProperties: false
    required:
    - alterations
    properties:
      alterations:
        type: array
        description: Words that are synonymous with each other.
        maxLength: 20
        minLength: 1
        items:
          type: string
  InnerErrorModel:
    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.
    additionalProperties: false
    properties:
      code:
        type: string
        description: A more specific error code than was provided by the containing error.
      innerError:
        description: An object containing more specific information than the current object about the error.
        $ref: '#/definitions/InnerErrorModel'
  Error:
    type: object
    description: The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    additionalProperties: false
    required:
    - code
    properties:
      code:
        description: One of a server-defined set of error codes.
        $ref: '#/definitions/ErrorCode'
      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/Error'
      innerError:
        description: An object containing more specific information than the current object about the error.
        $ref: '#/definitions/InnerErrorModel'
parameters:
  KbId:
    type: string
    name: kbId
    in: path
    required: true
    x-nullable: false
    description: Knowledgebase id.
    x-ms-parameter-location: method
  WordAlterations:
    name: wordAlterations
    in: body
    required: true
    schema:
      $ref: '#/definitions/WordAlterationsDTO'
    x-nullable: true
    description: New alterations data.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'