Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added text/plain responses to cat APIs. #360

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

dblock
Copy link
Member

@dblock dblock commented Jun 25, 2024

Description

  • Adds text/plain response types to cat APIs.
  • Fixes passing array parameters such as h=status,timestamp by serializing them.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Contributor

github-actions bot commented Jun 25, 2024

Changes Analysis

Commit SHA: a056917
Comparing To SHA: 6081d1a

API Changes

Summary

└─┬Paths
  ├─┬/_cat/aliases/{name}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23119:11)
  ├─┬/_cat/fielddata/{fields}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23161:11)
  ├─┬/_cat/snapshots
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23307:11)
  ├─┬/_cat/pit_segments/_all
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23129:11)
  ├─┬/_cat/health
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23171:11)
  ├─┬/_cat/segments/{index}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23287:11)
  ├─┬/_cat/recovery/{index}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23257:11)
  ├─┬/_cat/segment_replication
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23277:11)
  ├─┬/_cat/shards/{index}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23297:11)
  ├─┬/_cat/segments
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23287:11)
  ├─┬/_cat/fielddata
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23161:11)
  ├─┬/_cat/thread_pool/{thread_pool_patterns}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23337:11)
  ├─┬/_cat/nodes
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23217:11)
  ├─┬/_cat/count
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23151:11)
  ├─┬/_cat/templates
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23327:11)
  ├─┬/_cat/aliases
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23119:11)
  ├─┬/_cat/indices
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23187:11)
  ├─┬/_cat/templates/{name}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23327:11)
  ├─┬/_cat/pit_segments
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23237:11)
  ├─┬/_cat/segment_replication/{index}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23277:11)
  ├─┬/_cat/snapshots/{repository}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23307:11)
  ├─┬/_cat/master
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23197:11)
  ├─┬/_cat/thread_pool
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23337:11)
  ├─┬/_cat/shards
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23297:11)
  ├─┬/_cat/repositories
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23267:11)
  ├─┬/_cat/recovery
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23257:11)
  ├─┬/_cat/tasks
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23317:11)
  ├─┬/_cat/pending_tasks
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23227:11)
  ├─┬/_cat/allocation/{node_id}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23139:11)
  ├─┬/_cat/count/{index}
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23151:11)
  ├─┬/_cat/allocation
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23139:11)
  ├─┬/_cat/nodeattrs
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23207:11)
  ├─┬/_cat/plugins
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23247:11)
  └─┬/_cat/indices/{index}
    └─┬GET
      └─┬Responses
        └─┬200
          └──[➕] content (23187:11)

Document Element Total Changes Breaking Changes
paths 34 0
  • Total Changes: 34
  • Additions: 34

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/9686720257/artifacts/1642188642

API Coverage

Before After Δ
Covered (%) 483 (47.31 %) 483 (47.31 %) 0 (0 %)
Uncovered (%) 538 (52.69 %) 538 (52.69 %) 0 (0 %)
Unknown 24 24 0

@Xtansia Xtansia merged commit 73d5524 into opensearch-project:main Jun 27, 2024
8 of 9 checks passed
@dblock dblock deleted the cat-apis branch June 27, 2024 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants