Microsoft Azure SynonymMaps API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SynonymMaps API
schemes:
- https
tags:
- name: SynonymMaps
paths:
  /synonymmaps('{synonymMapName}'):
    put:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsCreateorupdate
      x-ms-examples:
        SearchServiceCreateOrUpdateSynonymMap:
          $ref: ./examples/SearchServiceCreateOrUpdateSynonymMap.json
      description: Creates a new synonym map or updates a synonym map if it already exists.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map
      parameters:
      - name: synonymMapName
        in: path
        required: true
        type: string
        description: The name of the synonym map to create or update.
      - name: synonymMap
        in: body
        required: true
        schema:
          $ref: '#/definitions/SynonymMap'
        description: The definition of the synonym map to create or update.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/PreferHeaderParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Put Synonymmaps Synonymmapname
    delete:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsDelete
      x-ms-examples:
        SearchServiceDeleteSynonymMap:
          $ref: ./examples/SearchServiceDeleteSynonymMap.json
      description: Deletes a synonym map.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map
      parameters:
      - name: synonymMapName
        in: path
        required: true
        type: string
        description: The name of the synonym map to delete.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/IfMatchParameter'
      - $ref: '#/parameters/IfNoneMatchParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '204':
          description: ''
        '404':
          description: ''
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Delete Synonymmaps Synonymmapname
    get:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsGet
      x-ms-examples:
        SearchServiceGetSynonymMap:
          $ref: ./examples/SearchServiceGetSynonymMap.json
      description: Retrieves a synonym map definition.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map
      parameters:
      - name: synonymMapName
        in: path
        required: true
        type: string
        description: The name of the synonym map to retrieve.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Synonymmaps Synonymmapname
  /synonymmaps:
    get:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsList
      x-ms-examples:
        SearchServiceListSynonymMaps:
          $ref: ./examples/SearchServiceListSynonymMaps.json
      description: Lists all synonym maps available for a search service.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps
      parameters:
      - name: $select
        in: query
        required: false
        type: string
        description: Selects which top-level properties of the synonym maps 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: ''
          schema:
            $ref: '#/definitions/ListSynonymMapsResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Get Synonymmaps
    post:
      tags:
      - SynonymMaps
      operationId: microsoftAzureSynonymmapsCreate
      x-ms-examples:
        SearchServiceCreateSynonymMap:
          $ref: ./examples/SearchServiceCreateSynonymMap.json
      description: Creates a new synonym map.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map
      parameters:
      - name: synonymMap
        in: body
        required: true
        schema:
          $ref: '#/definitions/SynonymMap'
        description: The definition of the synonym map to create.
      - $ref: '#/parameters/ClientRequestIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SynonymMap'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/SearchError'
      summary: Microsoft Azure Post Synonymmaps
definitions:
  ListSynonymMapsResult:
    properties:
      value:
        x-ms-client-name: SynonymMaps
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/SynonymMap'
        description: The synonym maps in the Search service.
    required:
    - value
    description: Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps.
  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.
  SynonymMap:
    properties:
      name:
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Naming-rules
        type: string
        description: The name of the synonym map.
      format:
        type: string
        enum:
        - solr
        x-ms-enum:
          name: SynonymMapFormat
          modelAsString: false
          values:
          - value: solr
            name: Solr
            description: Selects the SOLR format for synonym maps.
        description: The format of the synonym map. Only the 'solr' format is currently supported.
      synonyms:
        type: string
        description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.
        externalDocs:
          url: https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat
      encryptionKey:
        $ref: '#/definitions/SearchResourceEncryptionKey'
        description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
        externalDocs:
          url: https://aka.ms/azure-search-encryption-with-cmk
      '@odata.etag':
        x-ms-client-name: ETag
        type: string
        description: The ETag of the synonym map.
    required:
    - name
    - format
    - synonyms
    description: Represents a synonym map definition.
  AzureActiveDirectoryApplicationCredentials:
    properties:
      applicationId:
        type: string
        description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application.
      applicationSecret:
        type: string
        description: The authentication key of the specified AAD application.
    required:
    - applicationId
    description: Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.
  SearchResourceEncryptionKey:
    properties:
      keyVaultKeyName:
        x-ms-client-name: keyName
        type: string
        description: The name of your Azure Key Vault key to be used to encrypt your data at rest.
      keyVaultKeyVersion:
        x-ms-client-name: keyVersion
        type: string
        description: The version of your Azure Key Vault key to be used to encrypt your data at rest.
      keyVaultUri:
        x-ms-client-name: vaultUri
        type: string
        description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net.
      accessCredentials:
        $ref: '#/definitions/AzureActiveDirectoryApplicationCredentials'
        description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.
        externalDocs:
          url: https://aka.ms/azure-search-msi
    required:
    - keyVaultKeyName
    - keyVaultKeyVersion
    - keyVaultUri
    description: A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps.
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
  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
  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.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'