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

Fixed GET /_cat returning a text/plain response. #357

Merged
merged 2 commits into from
Jun 24, 2024

Conversation

dblock
Copy link
Member

@dblock dblock commented Jun 21, 2024

Description

The GET /_cat API (https://opensearch.org/docs/latest/api-reference/cat/index/) is not correctly documented. It does not accept any parameters as far as I can see and returns text/plain.

This PR fixes the schema for /_cat.

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.

@dblock dblock force-pushed the cat-help branch 2 times, most recently from 538334e to 5c93cd8 Compare June 21, 2024 20:06
Copy link
Contributor

github-actions bot commented Jun 21, 2024

Changes Analysis

Commit SHA: 7104061
Comparing To SHA: 6083bf5

API Changes

Summary

├─┬Paths
│ └─┬/_cat
│   └─┬GET
│     ├──[➖] parameters (12063:13)❌ 
│     ├──[➖] parameters (12055:13)❌ 
│     └─┬Responses
│       └─┬200
│         ├──[➕] content (23169:11)
│         └──[➖] content (23190:11)❌ 
└─┬Components
  ├──[➖] parameters (12055:7)❌ 
  ├──[➖] parameters (12063:7)❌ 
  └──[➖] schemas (38442:7)❌ 

Document Element Total Changes Breaking Changes
paths 4 3
components 3 3
  • BREAKING Changes: 6 out of 7
  • Removals: 6
  • Additions: 1
  • Breaking Removals: 6

Report

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

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 marked this pull request as ready for review June 21, 2024 20:08
@dblock dblock force-pushed the cat-help branch 2 times, most recently from bfc4b8f to 24c19db Compare June 21, 2024 20:28
@dblock dblock changed the title Add support for plain/text responses and fix GET /_cat. Fixed GET /_cat returning a text/plain response. Jun 21, 2024
@Xtansia Xtansia merged commit 7452827 into opensearch-project:main Jun 24, 2024
9 checks passed
@dblock dblock deleted the cat-help branch June 24, 2024 13:46
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