Azure AI Search API

openapi: 3.1.0
info:
  title: Azure AI Search API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 14 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Azure AI Search has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 12
    pages-with-code: 2
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://learn.microsoft.com/en-us/rest/api/searchservice/common-http-request-and-response-headers-used-in-azure-search
  - https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
  - https://learn.microsoft.com/en-us/azure/search/search-manage-rest
  - https://learn.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-10.0
  - https://learn.microsoft.com/en-us/azure/search/search-security-api-keys
servers:
- url: https://management.azure.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl: Swagger provides an example cURL command in Unix/Linux syntax, which can be run at the command line with any bash shell\
          \ that uses Unix/Linux syntax, including Git Bash from Git for Windows . \n Request URL: A simplified representation of the HTTP request\
          \ made by Swagger UI's JavaScript code for the API call. Actual requests can include details such as headers and query parameters and\
          \ a reques"
  /indexes:
    post:
      operationId: post_indexes
      tags:
      - Indexes
      summary: Common HTTP request and response headers (Azure AI Search)
      x-source: https://learn.microsoft.com/en-us/rest/api/searchservice/common-http-request-and-response-headers-used-in-azure-search
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_indexes
      tags:
      - Indexes
      summary: Common HTTP request and response headers (Azure AI Search)
      x-source: https://learn.microsoft.com/en-us/rest/api/searchservice/common-http-request-and-response-headers-used-in-azure-search
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /indexes/my-new-index/docs:
    get:
      operationId: get_indexes_my_new_index_docs
      tags:
      - Indexes
      summary: Query an index
      x-source: https://learn.microsoft.com/en-us/azure/search/search-security-api-keys
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  ? /subscriptions/{subscriptionid}/resourceGroups/{resourcegroupname}/providers/Microsoft.Search/searchServices/{searchservicename}/createQueryKey/{name}
  : post:
      operationId: post_subscriptions_subscriptionid_resourceGroups_resourcegroupname_providers_Mic
      tags:
      - Subscriptions
      summary: Create Query Keys in the Management REST API
      x-source: https://learn.microsoft.com/en-us/azure/search/search-security-api-keys
      parameters:
      - name: subscriptionid
        in: path
        required: true
        schema:
          type: string
      - name: resourcegroupname
        in: path
        required: true
        schema:
          type: string
      - name: searchservicename
        in: path
        required: true
        schema:
          type: string
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  ? /subscriptions/{subscriptionid}/resourceGroups/{resourceGroup}/providers//Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys
  : post:
      operationId: post_subscriptions_subscriptionid_resourceGroups_resourceGroup_providers_Microso
      tags:
      - Subscriptions
      summary: Return admin keys
      x-source: https://learn.microsoft.com/en-us/azure/search/search-security-api-keys
      parameters:
      - name: subscriptionid
        in: path
        required: true
        schema:
          type: string
      - name: resourceGroup
        in: path
        required: true
        schema:
          type: string
      - name: searchServiceName
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /swagger/v1/swagger.json:
    get:
      operationId: get_swagger_v1_swagger_json
      tags:
      - Swagger
      summary: GET /swagger/v1/swagger.json
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-10.0
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSwaggerV1SwaggerJsonResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i -H \"Authorization: Bearer {TOKEN}\" https://localhost:{PORT}/swagger/v1/swagger.json\n where the {TOKEN} placeholder\
          \ is the JWT bearer token and the {PORT} placeholder is the port number. \n For more information on testing with JWT tokens, see Generate\
          \ tokens with dotnet user-jwts . \n Generate an XML documentation file at compile time \n See GenerateDocumentationFile for more information.\
          \ \n Ne"
  /todoitems:
    get:
      operationId: get_todoitems
      tags:
      - Todoitems
      summary: Get all to-do items
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTodoitemsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_todoitems
      tags:
      - Todoitems
      summary: Add a new item
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTodoitemsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTodoitemsResponse'
      x-evidence:
        kind: documentation
  /todoitems/{id}:
    delete:
      operationId: delete_todoitems_id
      tags:
      - Todoitems
      summary: Delete an item
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_todoitems_id
      tags:
      - Todoitems
      summary: Get an item by ID
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTodoitemsIdResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_todoitems_id
      tags:
      - Todoitems
      summary: Partially update an item
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTodoitemsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_todoitems_id
      tags:
      - Todoitems
      summary: Update an existing item
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutTodoitemsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /weatherforecast:
    get:
      operationId: get_weatherforecast
      tags:
      - Weatherforecast
      summary: GetWeatherForecast
      x-source: https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-10.0
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWeatherforecastResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetResponse:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        isComplete:
          type: boolean
    GetSwaggerV1SwaggerJsonResponse:
      type: object
      properties:
        schema:
          type: object
          properties:
            type:
              type: string
            items:
              type: object
              properties:
                $ref:
                  type: string
    GetTodoitemsResponse:
      type: object
      properties:
        Array of to-do items:
          type: array
          description: Array of to‑do items
    PostTodoitemsRequest:
      type: object
      properties:
        To-do item:
          type: object
          description: To‑do item
      required:
      - To-do item
    PostTodoitemsResponse:
      type: object
      properties:
        To-do item:
          type: object
          description: To‑do item
    GetTodoitemsIdResponse:
      type: object
      properties:
        To-do item:
          type: object
          description: To‑do item
    PatchTodoitemsIdRequest:
      type: object
      properties:
        Partial to-do item:
          type: object
          description: Partial to‑do item
      required:
      - Partial to-do item
    PutTodoitemsIdRequest:
      type: object
      properties:
        To-do item:
          type: object
          description: To‑do item
      required:
      - To-do item
    GetWeatherforecastResponse:
      type: object
      properties:
        Array of WeatherForecast:
          type: array
          description: Array of weather forecast records
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Indexes
- name: Subscriptions
- name: Swagger
- name: Todoitems
- name: Weatherforecast