swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Skillsets API
schemes:
- https
tags:
- name: Skillsets
paths:
  /skillsets('{skillsetName}'):
    put:
      tags:
      - Skillsets
      operationId: microsoftAzureSkillsetsCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateSkillset:
          $ref: ./examples/SearchServiceCreateOrUpdateSkillset.json
      description: Creates a new skillset in a search service or updates the skillset if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/update-skillset
      parameters:
      - name: skillsetName
        in: path
        required: true
        type: string
        description: The name of the skillset to create or update.
      - name: skillset
        in: body
        required: true
        schema:
          $ref: '#/definitions/SearchIndexerSkillset'
        description: The skillset containing one or more skills to create or update in a search service.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/PreferHeaderParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: The skillset is successfully updated.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        '201':
          description: The skillset is successfully created.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Put Skillsets Skillsetname
    delete:
      tags:
      - Skillsets
      operationId: microsoftAzureSkillsetsDelete
      x-ms-examples:
        SearchServiceDeleteSkillset:
          $ref: ./examples/SearchServiceDeleteSkillset.json
      description: Deletes a skillset in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/delete-skillset
      parameters:
      - name: skillsetName
        in: path
        required: true
        type: string
        description: The name of the skillset to delete.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: The skillset is successfully deleted.
        '404':
          description: The provided skillset name is not found.
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Delete Skillsets Skillsetname
    get:
      tags:
      - Skillsets
      operationId: microsoftAzureSkillsetsGet
      x-ms-examples:
        SearchServiceGetSkillset:
          $ref: ./examples/SearchServiceGetSkillset.json
      description: Retrieves a skillset in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/get-skillset
      parameters:
      - name: skillsetName
        in: path
        required: true
        type: string
        description: The name of the skillset to retrieve.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: The skillset is successfully returned.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Skillsets Skillsetname
  /skillsets:
    get:
      tags:
      - Skillsets
      operationId: microsoftAzureSkillsetsList
      x-ms-examples:
        SearchServiceListSkillsets:
          $ref: ./examples/SearchServiceListSkillsets.json
      description: List all skillsets in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/list-skillset
      parameters:
      - name: $select
        in: query
        required: false
        type: string
        description: Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: The list is successfully returned.
          schema:
            $ref: '#/definitions/ListSkillsetsResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Skillsets
    post:
      tags:
      - Skillsets
      operationId: microsoftAzureSkillsetsCreate
      x-ms-examples:
        SearchServiceCreateSkillset:
          $ref: ./examples/SearchServiceCreateSkillset.json
      description: Creates a new skillset in a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/create-skillset
      parameters:
      - name: skillset
        in: body
        required: true
        schema:
          $ref: '#/definitions/SearchIndexerSkillset'
        description: The skillset containing one or more skills to create in a search service.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: The skillset is successfully created.
          schema:
            $ref: '#/definitions/SearchIndexerSkillset'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Skillsets
definitions:
  SearchIndexerKnowledgeStoreTableProjectionSelector:
    properties:
      tableName:
        type: string
        description: Name of the Azure table to store projected data in.
    required:
    - generatedKeyName
    - tableName
    allOf:
    - $ref: '#/definitions/SearchIndexerKnowledgeStoreProjectionSelector'
    description: Description for what data to store in Azure Tables.
  CognitiveServicesAccount:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the cognitive service resource attached to a skillset.
      description:
        type: string
        description: Description of the cognitive service resource attached to a skillset.
    required:
    - '@odata.type'
    description: Base type for describing any cognitive service resource attached to a skillset.
  SearchError:
    properties:
      code:
        type: string
        readOnly: true
        description: One of a server-defined set of error codes.
      message:
        type: string
        readOnly: true
        description: A human-readable representation of the error.
      details:
        type: array
        items:
          $ref: '#/definitions/SearchError'
        readOnly: true
        description: An array of details about specific errors that led to this reported error.
    required:
    - message
    description: Describes an error condition for the Azure Cognitive Search API.
  InputFieldMappingEntry:
    properties:
      name:
        type: string
        description: The name of the input.
      source:
        type: string
        description: The source of the input.
      sourceContext:
        type: string
        description: The source context used for selecting recursive inputs.
      inputs:
        type: array
        items:
          $ref: '#/definitions/InputFieldMappingEntry'
        description: The recursive inputs used when creating a complex type.
    required:
    - name
    description: Input field mapping for a skill.
  SearchIndexerKnowledgeStore:
    properties:
      storageConnectionString:
        type: string
        description: The connection string to the storage account projections will be stored in.
      projections:
        type: array
        items:
          $ref: '#/definitions/SearchIndexerKnowledgeStoreProjection'
          x-nullable: false
        description: A list of additional projections to perform during indexing.
    required:
    - storageConnectionString
    - projections
    externalDocs:
      url: https://docs.microsoft.com/azure/search/knowledge-store-projection-overview
    description: Definition of additional projections to azure blob, table, or files, of enriched data.
  SearchIndexerKnowledgeStoreBlobProjectionSelector:
    properties:
      storageContainer:
        type: string
        description: Blob container to store projections in.
    allOf:
    - $ref: '#/definitions/SearchIndexerKnowledgeStoreProjectionSelector'
    required:
    - storageContainer
    description: Abstract class to share properties between concrete selectors.
  SearchIndexerSkillset:
    properties:
      name:
        type: string
        description: The name of the skillset.
      description:
        type: string
        description: The description of the skillset.
      skills:
        type: array
        items:
          $ref: '#/definitions/SearchIndexerSkill'
        description: A list of skills in the skillset.
      cognitiveServices:
        x-ms-client-name: CognitiveServicesAccount
        $ref: '#/definitions/CognitiveServicesAccount'
        description: Details about cognitive services to be used when running skills.
      knowledgeStore:
        $ref: '#/definitions/SearchIndexerKnowledgeStore'
        description: Definition of additional projections to azure blob, table, or files, of enriched data.
      '@odata.etag':
        x-ms-client-name: ETag
        type: string
        description: The ETag of the skillset.
    required:
    - name
    - skills
    externalDocs:
      url: https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob
    description: A list of skills.
  SearchIndexerKnowledgeStoreFileProjectionSelector:
    allOf:
    - $ref: '#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector'
    description: Projection definition for what data to store in Azure Files.
  SearchIndexerKnowledgeStoreObjectProjectionSelector:
    allOf:
    - $ref: '#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector'
    description: Projection definition for what data to store in Azure Blob.
  ListSkillsetsResult:
    properties:
      value:
        x-ms-client-name: Skillsets
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/SearchIndexerSkillset'
        description: The skillsets defined in the Search service.
    required:
    - value
    description: Response from a list skillset request. If successful, it includes the full definitions of all skillsets.
  OutputFieldMappingEntry:
    properties:
      name:
        type: string
        description: The name of the output defined by the skill.
      targetName:
        type: string
        description: The target name of the output. It is optional and default to name.
    required:
    - name
    externalDocs:
      url: https://docs.microsoft.com/rest/api/searchservice/naming-rules
    description: Output field mapping for a skill.
  SearchIndexerKnowledgeStoreProjectionSelector:
    properties:
      referenceKeyName:
        type: string
        description: Name of reference key to different projection.
      generatedKeyName:
        type: string
        description: Name of generated key to store projection under.
      source:
        type: string
        description: Source data to project.
      sourceContext:
        type: string
        description: Source context for complex projections.
      inputs:
        type: array
        items:
          $ref: '#/definitions/InputFieldMappingEntry'
        description: Nested inputs for complex projections.
    description: Abstract class to share properties between concrete selectors.
  SearchIndexerSkill:
    discriminator: '@odata.type'
    properties:
      '@odata.type':
        type: string
        description: Identifies the concrete type of the skill.
      name:
        type: string
        description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.
      description:
        type: string
        description: The description of the skill which describes the inputs, outputs, and usage of the skill.
      context:
        type: string
        description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.
      inputs:
        type: array
        items:
          $ref: '#/definitions/InputFieldMappingEntry'
        description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
      outputs:
        type: array
        items:
          $ref: '#/definitions/OutputFieldMappingEntry'
        description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.
    required:
    - '@odata.type'
    - inputs
    - outputs
    externalDocs:
      url: https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills
    description: Base type for skills.
  SearchIndexerKnowledgeStoreProjection:
    properties:
      tables:
        type: array
        items:
          $ref: '#/definitions/SearchIndexerKnowledgeStoreTableProjectionSelector'
          x-nullable: false
        description: Projections to Azure Table storage.
      objects:
        type: array
        items:
          $ref: '#/definitions/SearchIndexerKnowledgeStoreObjectProjectionSelector'
          x-nullable: false
        description: Projections to Azure Blob storage.
      files:
        type: array
        items:
          $ref: '#/definitions/SearchIndexerKnowledgeStoreFileProjectionSelector'
          x-nullable: false
        description: Projections to Azure File storage.
    description: Container object for various projection selectors.
parameters:
  PreferHeaderParameter:
    name: Prefer
    in: header
    required: true
    type: string
    enum:
    - return=representation
    description: For HTTP PUT requests, instructs the service to return the created/updated resource on success.
    x-ms-parameter-location: method
  IfMatchParameter:
    name: If-Match
    in: header
    required: false
    type: string
    description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
    x-ms-parameter-location: method
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  IfNoneMatchParameter:
    name: If-None-Match
    in: header
    required: false
    type: string
    description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
    x-ms-parameter-location: method
  ClientRequestIdParameter:
    name: x-ms-client-request-id
    in: header
    required: false
    type: string
    format: uuid
    description: The tracking ID sent with the request to help with debugging.
    x-ms-client-request-id: true
    x-ms-parameter-grouping:
      name: request-options
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'