index.yaml

$schema: ../../../json_schemas/test_story.schema.yaml

description: Test endpoints relevant the lifecycle of an index, from creation to deletion.
epilogues:
  - path: /books
    method: DELETE
    status: [200, 404]
  - path: /games
    method: DELETE
    status: [200, 404]
chapters:
  - synopsis: Create an index named `books` with mappings and settings.
    path: /{index}
    method: PUT
    parameters:
      index: books
    request:
      payload:
        mappings:
          properties:
            name:
              type: keyword
            age:
              type: integer
        settings:
          number_of_shards: 5
          number_of_replicas: 2
    response:
      status: 200

  - synopsis: Create an index named `games` with default settings.
    path: /{index}
    method: PUT
    parameters:
      index: games

  - synopsis: Check if the index `books` exists. It should.
    path: /{index}
    method: HEAD
    parameters:
      index: books
      allow_no_indices: true
      expand_wildcards: all
      flat_settings: true
      include_defaults: true
      ignore_unavailable: true
      local: true

  - synopsis: Check if the index `movies` exists. It should not.
    path: /{index}
    method: HEAD
    parameters:
      index: movies
    response:
      status: 404

  - synopsis: Check if the index `movies` exists (cluster_manager_timeout). It should not.
    path: /{index}
    method: HEAD
    version: '>= 2.0'
    parameters:
      index: movies
      cluster_manager_timeout: 10s
    response:
      status: 404

  - synopsis: Retrieve the mappings and settings of the `books` and `games` indices.
    path: /{index}
    method: GET
    parameters:
      index: books,games
      flat_settings: true

  - synopsis: Delete the `books` and `games` indices.
    path: /{index}
    method: DELETE
    version: < 2.0
    parameters:
      index: books,games

  - synopsis: Delete the `books` index (cluster_manager_timeout).
    path: /{index}
    method: DELETE
    version: '>= 2.0'
    parameters:
      index: books,games
      cluster_manager_timeout: 10s

  - synopsis: Delete a nonexistent index `movies`.
    path: /{index}
    method: DELETE
    parameters:
      index: movies
    response:
      status: 404