Microsoft Azure Documents API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Documents API
tags:
- name: Documents
paths:
  /docs/$count:
    get:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsCount
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Count-Documents
      x-ms-examples:
        SearchIndexCountDocuments:
          $ref: ./examples/SearchIndexCountDocuments.json
      description: Queries the number of documents in the Azure Search index.
      parameters:
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int64
      summary: Microsoft Azure Get Docs $count
  /docs:
    get:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsSearchget
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Search-Documents
      x-ms-examples:
        SearchIndexSearchDocumentsGet:
          $ref: ./examples/SearchIndexSearchDocumentsGet.json
      description: Searches for documents in the Azure Search index.
      parameters:
      - name: search
        in: query
        description: A full-text search query expression; Use "*" or omit this parameter to match all documents.
        x-ms-client-name: SearchText
        schema:
          type: string
      - name: $count
        in: query
        description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
        x-ms-client-name: IncludeTotalResultCount
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: boolean
      - name: facet
        in: query
        description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.
        x-ms-client-name: Facets
        x-ms-parameter-grouping:
          name: SearchParameters
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: $filter
        in: query
        description: The OData $filter expression to apply to the search query.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: string
      - name: highlight
        in: query
        description: The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.
        x-ms-client-name: HighlightFields
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: array
          items:
            type: string
      - name: highlightPostTag
        in: query
        description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: string
      - name: highlightPreTag
        in: query
        description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: string
      - name: minimumCoverage
        in: query
        description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: number
          format: double
      - name: $orderby
        in: query
        description: The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
        x-ms-client-name: OrderBy
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: array
          items:
            type: string
      - name: queryType
        in: query
        x-ms-enum:
          name: QueryType
          modelAsString: false
        description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: string
          enum:
          - simple
          - full
      - name: scoringParameter
        in: query
        x-ms-client-name: ScoringParameters
        description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
        x-ms-parameter-grouping:
          name: SearchParameters
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: scoringProfile
        in: query
        description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: string
      - name: searchFields
        in: query
        description: The list of field names to include in the full-text search.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: array
          items:
            type: string
      - name: searchMode
        in: query
        x-ms-enum:
          name: SearchMode
          modelAsString: false
        description: A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: string
          enum:
          - any
          - all
      - name: $select
        in: query
        description: The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: array
          items:
            type: string
      - name: $skip
        in: query
        description: The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: integer
          format: int32
      - name: $top
        in: query
        description: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.
        x-ms-parameter-grouping:
          name: SearchParameters
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: Response containing documents that match the search criteria.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSearchResult'
      summary: Microsoft Azure Get Docs
  /docs/search.post.search:
    post:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsSearchpost
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Search-Documents
      x-ms-examples:
        SearchIndexSearchDocumentsPost:
          $ref: ./examples/SearchIndexSearchDocumentsPost.json
      description: Searches for documents in the Azure Search index.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: Response containing documents that match the search criteria.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSearchResult'
      summary: Microsoft Azure Post Docs Search Post Search
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
              description: The Search request.
        description: The definition of the Search request.
        required: true
  /docs('{key}'):
    get:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsGet
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/lookup-document
      x-ms-examples:
        SearchIndexGetDocument:
          $ref: ./examples/SearchIndexGetDocument.json
      description: Retrieves a document from the Azure Search index.
      parameters:
      - name: key
        in: path
        required: true
        description: The key of the document to retrieve.
        schema:
          type: string
      - name: $select
        in: query
        description: List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.
        x-ms-client-name: SelectedFields
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      responses:
        '200':
          description: Response containing the requested document.
          content:
            application/json:
              schema:
                type: object
      summary: Microsoft Azure Get Docs Key
  /docs/search.suggest:
    get:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsSuggestget
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/suggestions
      x-ms-examples:
        SearchIndexSuggestDocumentsGet:
          $ref: ./examples/SearchIndexSuggestDocumentsGet.json
      description: Suggests documents in the Azure Search index that match the given partial query text.
      parameters:
      - name: search
        in: query
        required: true
        description: The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.
        x-ms-client-name: SearchText
        schema:
          type: string
      - name: suggesterName
        in: query
        required: true
        description: The name of the suggester as specified in the suggesters collection that's part of the index definition.
        schema:
          type: string
      - name: $filter
        in: query
        description: An OData expression that filters the documents considered for suggestions.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: string
      - name: fuzzy
        in: query
        description: A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.
        x-ms-client-name: UseFuzzyMatching
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: boolean
      - name: highlightPostTag
        in: query
        description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: string
      - name: highlightPreTag
        in: query
        description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: string
      - name: minimumCoverage
        in: query
        description: A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: number
          format: double
      - name: $orderby
        in: query
        x-ms-client-name: OrderBy
        description: The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: array
          items:
            type: string
      - name: searchFields
        in: query
        description: The list of field names to search for the specified search text. Target fields must be included in the specified suggester.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: The list of fields to retrieve. If unspecified, only the key field will be included in the results.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: array
          items:
            type: string
      - name: $top
        in: query
        description: The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.
        x-ms-parameter-grouping:
          name: SuggestParameters
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: Response containing suggested documents that match the partial input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSuggestResult'
      summary: Microsoft Azure Get Docs Search Suggest
  /docs/search.post.suggest:
    post:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsSuggestpost
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/suggestions
      x-ms-examples:
        SearchIndexSuggestDocumentsPost:
          $ref: ./examples/SearchIndexSuggestDocumentsPost.json
      description: Suggests documents in the Azure Search index that match the given partial query text.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: Response containing suggested documents that match the partial input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSuggestResult'
      summary: Microsoft Azure Post Docs Search Post Suggest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestRequest'
        description: The Suggest request.
        required: true
  /docs/search.index:
    post:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsIndex
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents
      x-ms-examples:
        SearchIndexIndexDocuments:
          $ref: ./examples/SearchIndexIndexDocuments.json
      description: Sends a batch of document write actions to the Azure Search index.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: Response containing the status of operations for all actions in the batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIndexResult'
        '207':
          description: Response containing the status of operations for all actions in the batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentIndexResult'
      summary: Microsoft Azure Post Docs Search Index
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexBatch'
        description: The batch of index actions.
        required: true
  /docs/search.autocomplete:
    get:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsAutocompleteget
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/autocomplete
      x-ms-examples:
        SearchIndexAutocompleteDocumentsGet:
          $ref: ./examples/SearchIndexAutocompleteDocumentsGet.json
      description: Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.
      parameters:
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: search
        in: query
        required: true
        description: The incomplete term which should be auto-completed.
        x-ms-client-name: SearchText
        schema:
          type: string
      - name: suggesterName
        in: query
        required: true
        description: The name of the suggester as specified in the suggesters collection that's part of the index definition.
        schema:
          type: string
      - name: autocompleteMode
        in: query
        x-ms-enum:
          name: AutocompleteMode
          modelAsString: false
        description: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: string
          enum:
          - oneTerm
          - twoTerms
          - oneTermWithContext
      - name: $filter
        in: query
        description: An OData expression that filters the documents used to produce completed terms for the Autocomplete result.
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: string
      - name: fuzzy
        in: query
        description: A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
        x-ms-client-name: UseFuzzyMatching
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: boolean
      - name: highlightPostTag
        in: query
        description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: string
      - name: highlightPreTag
        in: query
        description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: string
      - name: minimumCoverage
        in: query
        description: A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: number
          format: double
      - name: searchFields
        in: query
        description: The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: array
          items:
            type: string
      - name: $top
        in: query
        description: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.
        x-ms-parameter-grouping:
          name: AutocompleteParameters
        schema:
          type: integer
          format: int32
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutocompleteResult'
                description: The result of Autocomplete query.
      summary: Microsoft Azure Get Docs Search Autocomplete
  /docs/search.post.autocomplete:
    post:
      tags:
      - Documents
      operationId: microsoftAzureDocumentsAutocompletepost
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/autocomplete
      x-ms-examples:
        SearchIndexAutocompleteDocumentsPost:
          $ref: ./examples/SearchIndexAutocompleteDocumentsPost.json
      description: Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.
      parameters:
      - $ref: '#/components/parameters/ClientRequestIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutocompleteResult'
                description: The result of Autocomplete query.
      summary: Microsoft Azure Post Docs Search Post Autocomplete
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutocompleteRequest'
        description: The definition of the Autocomplete request.
        required: true
components:
  schemas:
    AutocompleteMode:
      type: string
      enum:
      - oneTerm
      - twoTerms
      - oneTermWithContext
      x-ms-enum:
        name: AutocompleteMode
        modelAsString: false
      description: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms.
    IndexAction:
      properties:
        '@search.action':
          type: string
          enum:
          - upload
          - merge
          - mergeOrUpload
          - delete
          x-ms-enum:
            name: IndexActionType
          x-ms-client-name: ActionType
          description: The operation to perform on a document in an indexing batch.
      additionalProperties: true
      description: Represents an index action that operates on a document.
    SuggestResult:
      properties:
        '@search.text':
          type: string
          readOnly: true
          description: The text of the suggestion result.
          x-ms-client-name: Text
      additionalProperties: true
      description: A result containing a document found by a suggestion query, plus associated metadata.
    SearchMode:
      type: string
      enum:
      - any
      - all
      x-ms-enum:
        name: SearchMode
        modelAsString: false
      description: Specifies whether any or all of the search terms must be matched in order to count the document as a match.
    SearchRequest:
      properties:
        count:
          type: boolean
          description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
          x-ms-client-name: IncludeTotalResultCount
        facets:
          externalDocs:
            url: https://docs.microsoft.com/rest/api/searchservice/Search-Documents
          type: array
          items:
            type: string
          description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.
        filter:
          externalDocs:
            url: https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search
          type: string
          description: The OData $filter expression to apply to the search query.
        highlight:
          type: string
          description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.
          x-ms-client-name: HighlightFields
        highlightPostTag:
          type: string
          description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.
        highlightPreTag:
          type: string
          description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.
        minimumCoverage:
          type: number
          format: double
          description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.
        orderby:
          x-ms-client-name: OrderBy
          type: string
          description: The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
        queryType:
          $ref: '#/components/schemas/QueryType'
          description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.
        scoringParameters:
          type: array
          items:
            type: string
          description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
        scoringProfile:
          type: string
          description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.
        search:
          type: string
          description: A full-text search query expression; Use "*" or omit this parameter to match all documents.
          x-ms-client-name: SearchText
        searchFields:
          type: string
          description: The comma-separated list of field names to include in the full-text search.
        searchMode:
          $ref: '#/components/schemas/SearchMode'
          description: A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.
        select:
          type: string
          description: The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.
        skip:
          type: integer
          format: int32
          description: The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead.
        top:
          type: integer
          format: int32
          description: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.
      description: Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
    IndexingResult:
      properties:
        key:
          type: string
          readOnly: true
          description: The key of a document that was in the indexing request.
        errorMessage:
          type: string
          readOnly: true
          description: The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded.
        status:
          x-ms-client-name: Succeeded
          type: boolean
          readOnly: true
          description: A value indicating whether the indexing operation succeeded for the document identified by the key.
        statusCode:
          type: integer
          format: int32
          readOnly: true
          description: 'The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy.'
      description: Status of an indexing operation for a single document.
    FacetResult:
      properties:
        count:
          type: integer
          format: int64
          readOnly: true
          description: The approximate count of documents falling within the bucket described by this facet.
      additionalProperties: true
      description: A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval.
    IndexBatch:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/IndexAction'
          description: The actions in the batch.
          x-ms-client-name: Actions
      required:
      - value
      description: Contains a batch of document write actions to send to the Azure Search index.
    SearchResult:
      properties:
        '@search.s

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-documents-api-openapi.yml