nodes.yaml

openapi: 3.1.0
info:
  title: OpenSearch Nodes API
  description: OpenSearch Nodes API.
  version: 1.0.0
paths:
  /_cluster/nodes/hot_threads:
    get:
      operationId: nodes.hot_threads.0
      x-operation-group: nodes.hot_threads
      x-ignorable: true
      deprecated: true
      x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons
      x-version-added: '1.0'
      x-version-deprecated: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_cluster/nodes/hotthreads:
    get:
      operationId: nodes.hot_threads.1
      x-operation-group: nodes.hot_threads
      x-ignorable: true
      deprecated: true
      x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented
      x-version-added: '1.0'
      x-version-deprecated: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_cluster/nodes/{node_id}/hot_threads:
    get:
      operationId: nodes.hot_threads.2
      x-operation-group: nodes.hot_threads
      x-ignorable: true
      deprecated: true
      x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons
      x-version-added: '1.0'
      x-version-deprecated: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::path.node_id'
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_cluster/nodes/{node_id}/hotthreads:
    get:
      operationId: nodes.hot_threads.3
      x-operation-group: nodes.hot_threads
      x-ignorable: true
      deprecated: true
      x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented
      x-version-added: '1.0'
      x-version-deprecated: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::path.node_id'
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_nodes:
    get:
      operationId: nodes.info.0
      x-operation-group: nodes.info
      x-version-added: '1.0'
      description: Returns information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/
      parameters:
        - $ref: '#/components/parameters/nodes.info::query.flat_settings'
        - $ref: '#/components/parameters/nodes.info::query.timeout'
      responses:
        '200':
          $ref: '#/components/responses/nodes.info@200'
  /_nodes/hot_threads:
    get:
      operationId: nodes.hot_threads.4
      x-operation-group: nodes.hot_threads
      x-version-added: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_nodes/hotthreads:
    get:
      operationId: nodes.hot_threads.5
      x-operation-group: nodes.hot_threads
      x-ignorable: true
      deprecated: true
      x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented
      x-version-added: '1.0'
      x-version-deprecated: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_nodes/reload_secure_settings:
    post:
      operationId: nodes.reload_secure_settings.0
      x-operation-group: nodes.reload_secure_settings
      x-version-added: '1.0'
      description: Reloads secure settings.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/
      parameters:
        - $ref: '#/components/parameters/nodes.reload_secure_settings::query.timeout'
      requestBody:
        $ref: '#/components/requestBodies/nodes.reload_secure_settings'
      responses:
        '200':
          $ref: '#/components/responses/nodes.reload_secure_settings@200'
  /_nodes/stats:
    get:
      operationId: nodes.stats.0
      x-operation-group: nodes.stats
      x-version-added: '1.0'
      description: Returns statistical information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/
      parameters:
        - $ref: '#/components/parameters/nodes.stats::query.completion_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fields'
        - $ref: '#/components/parameters/nodes.stats::query.groups'
        - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes'
        - $ref: '#/components/parameters/nodes.stats::query.level'
        - $ref: '#/components/parameters/nodes.stats::query.timeout'
        - $ref: '#/components/parameters/nodes.stats::query.types'
      responses:
        '200':
          $ref: '#/components/responses/nodes.stats@200'
  /_nodes/stats/{metric}:
    get:
      operationId: nodes.stats.1
      x-operation-group: nodes.stats
      x-version-added: '1.0'
      description: Returns statistical information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/
      parameters:
        - $ref: '#/components/parameters/nodes.stats::path.metric'
        - $ref: '#/components/parameters/nodes.stats::query.completion_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fields'
        - $ref: '#/components/parameters/nodes.stats::query.groups'
        - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes'
        - $ref: '#/components/parameters/nodes.stats::query.level'
        - $ref: '#/components/parameters/nodes.stats::query.timeout'
        - $ref: '#/components/parameters/nodes.stats::query.types'
      responses:
        '200':
          $ref: '#/components/responses/nodes.stats@200'
  /_nodes/stats/{metric}/{index_metric}:
    get:
      operationId: nodes.stats.2
      x-operation-group: nodes.stats
      x-version-added: '1.0'
      description: Returns statistical information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/
      parameters:
        - $ref: '#/components/parameters/nodes.stats::path.index_metric'
        - $ref: '#/components/parameters/nodes.stats::path.metric'
        - $ref: '#/components/parameters/nodes.stats::query.completion_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fields'
        - $ref: '#/components/parameters/nodes.stats::query.groups'
        - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes'
        - $ref: '#/components/parameters/nodes.stats::query.level'
        - $ref: '#/components/parameters/nodes.stats::query.timeout'
        - $ref: '#/components/parameters/nodes.stats::query.types'
      responses:
        '200':
          $ref: '#/components/responses/nodes.stats@200'
  /_nodes/usage:
    get:
      operationId: nodes.usage.0
      x-operation-group: nodes.usage
      x-version-added: '1.0'
      description: Returns low-level information about REST actions usage on nodes.
      externalDocs:
        url: https://opensearch.org/docs/latest
      parameters:
        - $ref: '#/components/parameters/nodes.usage::query.timeout'
      responses:
        '200':
          $ref: '#/components/responses/nodes.usage@200'
  /_nodes/usage/{metric}:
    get:
      operationId: nodes.usage.1
      x-operation-group: nodes.usage
      x-version-added: '1.0'
      description: Returns low-level information about REST actions usage on nodes.
      externalDocs:
        url: https://opensearch.org/docs/latest
      parameters:
        - $ref: '#/components/parameters/nodes.usage::path.metric'
        - $ref: '#/components/parameters/nodes.usage::query.timeout'
      responses:
        '200':
          $ref: '#/components/responses/nodes.usage@200'
  /_nodes/{node_id_or_metric}:
    get:
      operationId: nodes.info.1
      x-operation-group: nodes.info
      x-version-added: '1.0'
      description: Returns information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/
      parameters:
        - $ref: '#/components/parameters/nodes.info::path.node_id_or_metric'
        - $ref: '#/components/parameters/nodes.info::query.flat_settings'
        - $ref: '#/components/parameters/nodes.info::query.timeout'
      responses:
        '200':
          $ref: '#/components/responses/nodes.info@200'
  /_nodes/{node_id}/hot_threads:
    get:
      operationId: nodes.hot_threads.6
      x-operation-group: nodes.hot_threads
      x-version-added: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::path.node_id'
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_nodes/{node_id}/hotthreads:
    get:
      operationId: nodes.hot_threads.7
      x-operation-group: nodes.hot_threads
      x-ignorable: true
      deprecated: true
      x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented
      x-version-added: '1.0'
      x-version-deprecated: '1.0'
      description: Returns information about hot threads on each node in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/
      parameters:
        - $ref: '#/components/parameters/nodes.hot_threads::path.node_id'
        - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.interval'
        - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots'
        - $ref: '#/components/parameters/nodes.hot_threads::query.threads'
        - $ref: '#/components/parameters/nodes.hot_threads::query.timeout'
        - $ref: '#/components/parameters/nodes.hot_threads::query.type'
      responses:
        '200':
          $ref: '#/components/responses/nodes.hot_threads@200'
  /_nodes/{node_id}/reload_secure_settings:
    post:
      operationId: nodes.reload_secure_settings.1
      x-operation-group: nodes.reload_secure_settings
      x-version-added: '1.0'
      description: Reloads secure settings.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/
      parameters:
        - $ref: '#/components/parameters/nodes.reload_secure_settings::path.node_id'
        - $ref: '#/components/parameters/nodes.reload_secure_settings::query.timeout'
      requestBody:
        $ref: '#/components/requestBodies/nodes.reload_secure_settings'
      responses:
        '200':
          $ref: '#/components/responses/nodes.reload_secure_settings@200'
  /_nodes/{node_id}/stats:
    get:
      operationId: nodes.stats.3
      x-operation-group: nodes.stats
      x-version-added: '1.0'
      description: Returns statistical information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/
      parameters:
        - $ref: '#/components/parameters/nodes.stats::path.node_id'
        - $ref: '#/components/parameters/nodes.stats::query.completion_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fields'
        - $ref: '#/components/parameters/nodes.stats::query.groups'
        - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes'
        - $ref: '#/components/parameters/nodes.stats::query.level'
        - $ref: '#/components/parameters/nodes.stats::query.timeout'
        - $ref: '#/components/parameters/nodes.stats::query.types'
      responses:
        '200':
          $ref: '#/components/responses/nodes.stats@200'
  /_nodes/{node_id}/stats/{metric}:
    get:
      operationId: nodes.stats.4
      x-operation-group: nodes.stats
      x-version-added: '1.0'
      description: Returns statistical information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/
      parameters:
        - $ref: '#/components/parameters/nodes.stats::path.metric'
        - $ref: '#/components/parameters/nodes.stats::path.node_id'
        - $ref: '#/components/parameters/nodes.stats::query.completion_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fields'
        - $ref: '#/components/parameters/nodes.stats::query.groups'
        - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes'
        - $ref: '#/components/parameters/nodes.stats::query.level'
        - $ref: '#/components/parameters/nodes.stats::query.timeout'
        - $ref: '#/components/parameters/nodes.stats::query.types'
      responses:
        '200':
          $ref: '#/components/responses/nodes.stats@200'
  /_nodes/{node_id}/stats/{metric}/{index_metric}:
    get:
      operationId: nodes.stats.5
      x-operation-group: nodes.stats
      x-version-added: '1.0'
      description: Returns statistical information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/
      parameters:
        - $ref: '#/components/parameters/nodes.stats::path.index_metric'
        - $ref: '#/components/parameters/nodes.stats::path.metric'
        - $ref: '#/components/parameters/nodes.stats::path.node_id'
        - $ref: '#/components/parameters/nodes.stats::query.completion_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields'
        - $ref: '#/components/parameters/nodes.stats::query.fields'
        - $ref: '#/components/parameters/nodes.stats::query.groups'
        - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes'
        - $ref: '#/components/parameters/nodes.stats::query.level'
        - $ref: '#/components/parameters/nodes.stats::query.timeout'
        - $ref: '#/components/parameters/nodes.stats::query.types'
      responses:
        '200':
          $ref: '#/components/responses/nodes.stats@200'
  /_nodes/{node_id}/usage:
    get:
      operationId: nodes.usage.2
      x-operation-group: nodes.usage
      x-version-added: '1.0'
      description: Returns low-level information about REST actions usage on nodes.
      externalDocs:
        url: https://opensearch.org/docs/latest
      parameters:
        - $ref: '#/components/parameters/nodes.usage::path.node_id'
        - $ref: '#/components/parameters/nodes.usage::query.timeout'
      responses:
        '200':
          $ref: '#/components/responses/nodes.usage@200'
  /_nodes/{node_id}/usage/{metric}:
    get:
      operationId: nodes.usage.3
      x-operation-group: nodes.usage
      x-version-added: '1.0'
      description: Returns low-level information about REST actions usage on nodes.
      externalDocs:
        url: https://opensearch.org/docs/latest
      parameters:
        - $ref: '#/components/parameters/nodes.usage::path.metric'
        - $ref: '#/components/parameters/nodes.usage::path.node_id'
        - $ref: '#/components/parameters/nodes.usage::query.timeout'
      responses:
        '200':
          $ref: '#/components/responses/nodes.usage@200'
  /_nodes/{node_id}/{metric}:
    get:
      operationId: nodes.info.3
      x-operation-group: nodes.info
      x-version-added: '1.0'
      description: Returns information about nodes in the cluster.
      externalDocs:
        url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/
      parameters:
        - $ref: '#/components/parameters/nodes.info::path.metric'
        - $ref: '#/components/parameters/nodes.info::path.node_id'
        - $ref: '#/components/parameters/nodes.info::query.flat_settings'
        - $ref: '#/components/parameters/nodes.info::query.timeout'
      responses:
        '200':
          $ref: '#/components/responses/nodes.info@200'
components:
  requestBodies:
    nodes.reload_secure_settings:
      content:
        application/json:
          schema:
            type: object
            properties:
              secure_settings_password:
                $ref: '../schemas/_common.yaml#/components/schemas/Password'
            description: An object containing the password for the opensearch keystore
  responses:
    nodes.hot_threads@200: {}
    nodes.info@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/nodes.info.yaml#/components/schemas/ResponseBase'
    nodes.reload_secure_settings@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/nodes.reload_secure_settings.yaml#/components/schemas/ResponseBase'
    nodes.stats@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/nodes.stats.yaml#/components/schemas/ResponseBase'
    nodes.usage@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/nodes.usage.yaml#/components/schemas/ResponseBase'
  parameters:
    nodes.hot_threads::path.node_id:
      name: node_id
      in: path
      description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
      schema:
        type: array
        description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
        items:
          type: string
      required: true
    nodes.hot_threads::query.ignore_idle_threads:
      name: ignore_idle_threads
      in: query
      description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.
      schema:
        type: boolean
        default: true
        description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.
    nodes.hot_threads::query.interval:
      name: interval
      in: query
      description: The interval for the second sampling of threads.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
    nodes.hot_threads::query.snapshots:
      name: snapshots
      in: query
      description: Number of samples of thread stacktrace.
      schema:
        type: integer
        default: 10
        description: Number of samples of thread stacktrace.
        format: int32
    nodes.hot_threads::query.threads:
      name: threads
      in: query
      description: Specify the number of threads to provide information for.
      schema:
        type: integer
        default: 3
        description: Specify the number of threads to provide information for.
        format: int32
    nodes.hot_threads::query.timeout:
      name: timeout
      in: query
      description: Operation timeout.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
    nodes.hot_threads::query.type:
      name: type
      in: query
      description: The type to sample.
      schema:
        $ref: '../schemas/nodes._common.yaml#/components/schemas/SampleType'
    nodes.info::path.node_id_or_metric:
      in: path
      name: node_id_or_metric
      description: |
        Limits the information returned to a list of node IDs or specific metrics.
        Supports a comma-separated list, such as node1,node2 or http,ingest.
      required: true
      schema:
        anyOf:
          - title: node_id
            $ref: '../schemas/_common.yaml#/components/schemas/NodeIds'
          - title: metric
            type: array
            items:
              $ref: '../schemas/nodes.info.yaml#/components/schemas/Metric'
      style: simple
    nodes.info::path.node_id:
      in: path
      name: node_id
      description: Comma-separated list of node IDs or names used to limit returned information.
      required: true
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/NodeIds'
      style: simple
    nodes.info::path.metric:
      in: path
      name: metric
      description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.
      required: true
      schema:
        type: array
        items:
          $ref: '../schemas/nodes.info.yaml#/components/schemas/Metric'
      style: simple
    nodes.info::query.flat_settings:
      in: query
      name: flat_settings
      description: If true, returns settings in flat format.
      schema:
        type: boolean
        default: false
      style: form
    nodes.info::query.timeout:
      in: query
      name: timeout
      description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
      style: form
    nodes.reload_secure_settings::path.node_id:
      in: path
      name: node_id
      description: The names of particular nodes in the cluster to target.
      required: true
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/NodeIds'
      style: simple
    nodes.reload_secure_settings::query.timeout:
      in: query
      name: timeout
      description: |-
        Period to wait for a response.
        If no response is received before the timeout expires, the request fails and returns an error.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
      style: form
    nodes.stats::path.index_metric:
      in: path
      name: index_metric
      description: Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.
      required: true
      schema:
        type: array
        items:
          $ref: '../schemas/nodes.stats.yaml#/components/schemas/IndexMetric'
      style: simple
    nodes.stats::path.metric:
      in: path
      name: metric
      description: Limit the information returned to the specified metrics
      required: true
      schema:
        type: array
        items:
          $ref: '../schemas/nodes.stats.yaml#/components/schemas/Metric'
      style: simple
    nodes.stats::path.node_id:
      in: path
      name: node_id
      description: Comma-separated list of node IDs or names used to limit returned information.
      required: true
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/NodeIds'
      style: simple
    nodes.stats::query.completion_fields:
      in: query
      name: completion_fields
      description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Fields'
      style: form
    nodes.stats::query.fielddata_fields:
      in: query
      name: fielddata_fields
      description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Fields'
      style: form
    nodes.stats::query.fields:
      in: query
      name: fields
      description: Comma-separated list or wildcard expressions of fields to include in the statistics.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Fields'
      style: form
    nodes.stats::query.groups:
      in: query
      name: groups
      description: Comma-separated list of search groups to include in the search statistics.
      schema:
        type: array
        items:
          type: string
      style: form
    nodes.stats::query.include_segment_file_sizes:
      in: query
      name: include_segment_file_sizes
      description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
      schema:
        type: boolean
        default: false
      style: form
    nodes.stats::query.level:
      in: query
      name: level
      description: Indicates whether statistics are aggregated at the cluster, index, or shard level.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Level'
      style: form
    nodes.stats::query.timeout:
      in: query
      name: timeout
      description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
      style: form
    nodes.stats::query.types:
      in: query
      name: types
      description: A comma-separated list of document types for the indexing index metric.
      schema:
        type: array
        items:
          type: string
      style: form
    nodes.usage::path.metric:
      in: path
      name: metric
      description: |-
        Limits the information returned to the specific metrics.
        A comma-separated list of the following options: `_all`, `rest_actions`.
      required: true
      schema:
        type: array
        items:
          $ref: '../schemas/nodes.usage.yaml#/components/schemas/Metric'
      style: simple
    nodes.usage::path.node_id:
      in: path
      name: node_id
      description: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
      required: true
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/NodeIds'
      style: simple
    nodes.usage::query.timeout:
      in: query
      name: timeout
      description: |-
        Period to wait for a response.
        If no response is received before the timeout expires, the request fails and returns an error.
      schema:
        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
      style: form