Skip to content

Added text/plain responses to cat APIs.#360

Merged
Xtansia merged 1 commit intoopensearch-project:mainfrom
dblock:cat-apis
Jun 27, 2024
Merged

Added text/plain responses to cat APIs.#360
Xtansia merged 1 commit intoopensearch-project:mainfrom
dblock:cat-apis

Conversation

@dblock
Copy link
Copy Markdown
Member

@dblock dblock commented Jun 25, 2024 •
edited
Loading

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jun 25, 2024 •
edited
Loading

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

@dblock dblock force-pushed the cat-apis branch 2 times, most recently from 175649b to 9cf8408 Compare June 26, 2024 17:36
@dblock dblock mentioned this pull request Jun 26, 2024
Open
@dblock dblock marked this pull request as ready for review June 26, 2024 18:19
@dblock dblock mentioned this pull request Jun 26, 2024
Merged
@dblock
Added text/plain responses to cat APIs.
a056917 
Signed-off-by: dblock <dblock@amazon.com>
@Xtansia Xtansia merged commit 73d5524 into opensearch-project:main Jun 27, 2024
@dblock dblock deleted the cat-apis branch June 27, 2024 19:05
@dblock dblock mentioned this pull request Jul 11, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Xtansia Xtansia Xtansia approved these changes

@harshavamsi harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

@sachetalva sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

@nhtruong nhtruong Awaiting requested review from nhtruong

@VachaShah VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

@Tokesh Tokesh Awaiting requested review from Tokesh Tokesh is a code owner

@aabeshov aabeshov Awaiting requested review from aabeshov aabeshov is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dblock @Xtansia