swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Text API
schemes:
- https
tags:
- name: Text
paths:
  /text/blocklists:
    get:
      operationId: microsoftAzureTextblocklistsListtextblocklists
      summary: Microsoft Azure Get All Text Blocklists
      description: Get all text blocklists details.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedTextBlocklist'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get All Text Blocklists:
          $ref: ./examples/ListTextBlocklists.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Text
  /text/blocklists/{blocklistName}:
    get:
      operationId: microsoftAzureTextblocklistsGettextblocklist
      summary: Microsoft Azure Get Text Blocklist By Blocklistname
      description: Returns text blocklist details.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: blocklistName
        in: path
        description: Text blocklist name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TextBlocklist'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get Text Blocklist By blocklistName:
          $ref: ./examples/GetTextBlocklist.json
      tags:
      - Text
    patch:
      operationId: microsoftAzureTextblocklistsCreateorupdatetextblocklist
      summary: Microsoft Azure Create Or Update Text Blocklist
      description: Updates a text blocklist. If the blocklistName does not exist, a new blocklist will be created.
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: blocklistName
        in: path
        description: Text blocklist name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
      - name: resource
        in: body
        description: The resource instance.
        required: true
        schema:
          $ref: '#/definitions/TextBlocklistCreateOrUpdate'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TextBlocklist'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/TextBlocklist'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Create Or Update Text Blocklist:
          $ref: ./examples/CreateOrUpdateTextBlocklist.json
      tags:
      - Text
    delete:
      operationId: microsoftAzureTextblocklistsDeletetextblocklist
      summary: Microsoft Azure Delete Text Blocklist By Blocklistname
      description: Deletes a text blocklist.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: blocklistName
        in: path
        description: Text blocklist name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Delete Text Blocklist By blocklistName:
          $ref: ./examples/DeleteTextBlocklist.json
      tags:
      - Text
  /text/blocklists/{blocklistName}:addOrUpdateBlocklistItems:
    post:
      operationId: microsoftAzureTextblocklistsAddorupdateblocklistitems
      summary: Microsoft Azure Add Or Update Blocklistitems To Text Blocklist
      description: Add or update blocklistItems to a text blocklist. You can add or update at most 100 blocklistItems in one request.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: blocklistName
        in: path
        description: Text blocklist name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
      - name: body
        in: body
        description: Options for adding or updating blocklist items.
        required: true
        schema:
          $ref: '#/definitions/AddOrUpdateTextBlocklistItemsOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/AddOrUpdateTextBlocklistItemsResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Add or Update BlocklistItems To Text Blocklist:
          $ref: ./examples/AddOrUpdateBlocklistItems.json
      tags:
      - Text
  /text/blocklists/{blocklistName}:removeBlocklistItems:
    post:
      operationId: microsoftAzureTextblocklistsRemoveblocklistitems
      summary: Microsoft Azure Remove Blocklistitems From Text Blocklist
      description: Remove blocklistItems from a text blocklist. You can remove at most 100 BlocklistItems in one request.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: blocklistName
        in: path
        description: Text blocklist name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
      - name: body
        in: body
        description: Options for removing blocklist items.
        required: true
        schema:
          $ref: '#/definitions/RemoveTextBlocklistItemsOptions'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Remove BlockItems From Text Blocklist:
          $ref: ./examples/RemoveBlocklistItems.json
      tags:
      - Text
  /text/blocklists/{blocklistName}/blocklistItems:
    get:
      operationId: microsoftAzureTextblocklistsListtextblocklistitems
      summary: Microsoft Azure Get All Blocklistitems By Blocklistname
      description: Get all blocklistItems in a text blocklist.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: blocklistName
        in: path
        description: Text blocklist name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
      - $ref: '#/parameters/Azure.Core.TopQueryParameter'
      - $ref: '#/parameters/Azure.Core.SkipQueryParameter'
      - $ref: '#/parameters/Azure.Core.MaxPageSizeQueryParameter'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedTextBlocklistItem'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get All BlockItems By blocklistName:
          $ref: ./examples/ListTextBlocklistItems.json
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Text
  /text/blocklists/{blocklistName}/blocklistItems/{blocklistItemId}:
    get:
      operationId: microsoftAzureTextblocklistsGettextblocklistitem
      summary: Microsoft Azure Get Blocklistitem By Blocklistname And Blocklistitemid
      description: Get blocklistItem by blocklistName and blocklistItemId from a text blocklist.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: blocklistName
        in: path
        description: Text blocklist name.
        required: true
        type: string
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
      - name: blocklistItemId
        in: path
        description: The service will generate a BlocklistItemId, which will be a UUID.
        required: true
        type: string
        maxLength: 64
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TextBlocklistItem'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Get BlockItem By blocklistName And blocklistItemId:
          $ref: ./examples/GetTextBlocklistItem.json
      tags:
      - Text
definitions:
  RemoveTextBlocklistItemsOptions:
    type: object
    description: The request to remove blocklistItems from a text blocklist.
    properties:
      blocklistItemIds:
        type: array
        description: Array of blocklistItemIds to remove.
        items:
          type: string
    required:
    - blocklistItemIds
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  PagedTextBlocklist:
    type: object
    description: Paged collection of TextBlocklist items
    properties:
      value:
        type: array
        description: The TextBlocklist items on this page
        items:
          $ref: '#/definitions/TextBlocklist'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  TextBlocklistItem:
    type: object
    description: Item in a TextBlocklist.
    properties:
      blocklistItemId:
        type: string
        description: The service will generate a BlocklistItemId, which will be a UUID.
        maxLength: 64
        readOnly: true
      description:
        type: string
        description: BlocklistItem description.
        maxLength: 1024
      text:
        type: string
        description: BlocklistItem content.
        maxLength: 128
    required:
    - blocklistItemId
    - text
  PagedTextBlocklistItem:
    type: object
    description: Paged collection of TextBlocklistItem items
    properties:
      value:
        type: array
        description: The TextBlocklistItem items on this page
        items:
          $ref: '#/definitions/TextBlocklistItem'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  AddOrUpdateTextBlocklistItemsResult:
    type: object
    description: The response of adding blocklistItems to the text blocklist.
    properties:
      blocklistItems:
        type: array
        description: Array of blocklistItems have been added.
        items:
          $ref: '#/definitions/TextBlocklistItem'
        x-ms-identifiers: []
    required:
    - blocklistItems
  AddOrUpdateTextBlocklistItemsOptions:
    type: object
    description: The request to add blocklistItems to a text blocklist.
    properties:
      blocklistItems:
        type: array
        description: Array of blocklistItems to add.
        items:
          $ref: '#/definitions/TextBlocklistItem'
        x-ms-identifiers: []
    required:
    - blocklistItems
  TextBlocklistCreateOrUpdate:
    type: object
    description: Text Blocklist.
    properties:
      blocklistName:
        type: string
        description: Text blocklist name.
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
        x-ms-mutability:
        - read
        - create
      description:
        type: string
        description: Text blocklist description.
        maxLength: 1024
  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: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  TextBlocklist:
    type: object
    description: Text Blocklist.
    properties:
      blocklistName:
        type: string
        description: Text blocklist name.
        maxLength: 64
        pattern: ^[0-9A-Za-z._~-]+$
        x-ms-mutability:
        - read
        - create
      description:
        type: string
        description: Text blocklist description.
        maxLength: 1024
    required:
    - blocklistName
  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: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  Azure.Core.MaxPageSizeQueryParameter:
    name: maxpagesize
    in: query
    description: The maximum number of result items per page.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  Azure.Core.SkipQueryParameter:
    name: skip
    in: query
    description: The number of result items to skip.
    required: false
    type: integer
    format: int32
    default: 0
    x-ms-parameter-location: method
  Azure.Core.TopQueryParameter:
    name: top
    in: query
    description: The number of result items to return.
    required: false
    type: integer
    format: int32
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    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'