cluster.reroute.yaml

openapi: 3.1.0
info:
  title: Schemas of cluster.reroute category
  description: Schemas of cluster.reroute category
  version: 1.0.0
paths: {}
components:
  schemas:
    Command:
      type: object
      properties:
        cancel:
          $ref: '#/components/schemas/CommandCancelAction'
        move:
          $ref: '#/components/schemas/CommandMoveAction'
        allocate_replica:
          $ref: '#/components/schemas/CommandAllocateReplicaAction'
        allocate_stale_primary:
          $ref: '#/components/schemas/CommandAllocatePrimaryAction'
        allocate_empty_primary:
          $ref: '#/components/schemas/CommandAllocatePrimaryAction'
    CommandCancelAction:
      type: object
      properties:
        index:
          $ref: '_common.yaml#/components/schemas/IndexName'
        shard:
          type: number
        node:
          type: string
        allow_primary:
          type: boolean
      required:
        - index
        - shard
        - node
    CommandMoveAction:
      type: object
      properties:
        index:
          $ref: '_common.yaml#/components/schemas/IndexName'
        shard:
          type: number
        from_node:
          description: The node to move the shard from
          type: string
        to_node:
          description: The node to move the shard to
          type: string
      required:
        - index
        - shard
        - from_node
        - to_node
    CommandAllocateReplicaAction:
      type: object
      properties:
        index:
          $ref: '_common.yaml#/components/schemas/IndexName'
        shard:
          type: number
        node:
          type: string
      required:
        - index
        - shard
        - node
    CommandAllocatePrimaryAction:
      type: object
      properties:
        index:
          $ref: '_common.yaml#/components/schemas/IndexName'
        shard:
          type: number
        node:
          type: string
        accept_data_loss:
          description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true
          type: boolean
      required:
        - index
        - shard
        - node
        - accept_data_loss
    RerouteExplanation:
      type: object
      properties:
        command:
          type: string
        decisions:
          type: array
          items:
            $ref: '#/components/schemas/RerouteDecision'
        parameters:
          $ref: '#/components/schemas/RerouteParameters'
      required:
        - command
        - decisions
        - parameters
    RerouteDecision:
      type: object
      properties:
        decider:
          type: string
        decision:
          type: string
        explanation:
          type: string
      required:
        - decider
        - decision
        - explanation
    RerouteParameters:
      type: object
      properties:
        allow_primary:
          type: boolean
        index:
          $ref: '_common.yaml#/components/schemas/IndexName'
        node:
          $ref: '_common.yaml#/components/schemas/NodeName'
        shard:
          type: number
        from_node:
          $ref: '_common.yaml#/components/schemas/NodeName'
        to_node:
          $ref: '_common.yaml#/components/schemas/NodeName'
      required:
        - allow_primary
        - index
        - node
        - shard