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

Add support for application/smile #386

Merged
merged 1 commit into from
Jul 10, 2024

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 8, 2024

Description

Add support for application/smile.

Thanks to @ngyewch for the recent work on the smile-js library to get this over the line!

Issues Resolved

Closes #372.

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 Jul 8, 2024

Changes Analysis

Commit SHA: ab88a52
Comparing To SHA: ba3d715

API Changes

Summary

└─┬Paths
  ├─┬/_cat/indices
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23228:11)
  ├─┬/_cat/health
  │ └─┬GET
  │   └─┬Responses
  │     └─┬200
  │       └──[➕] content (23197:11)
  └─┬/_cat/indices/{index}
    └─┬GET
      └─┬Responses
        └─┬200
          └──[➕] content (23228:11)

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

Report

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

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 July 9, 2024 14:05
Comment on lines 89 to 92
format: smile
response:
status: 200
content_type: application/yaml
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we not actually validating content_type against the response content-type header?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it, #392.

Comment on lines 47 to 54
- synopsis: This GET /_cat/health chapter returns application/smile and should pass.
path: /_cat/health
parameters:
format: cbor
method: GET
response:
status: 200
content_type: application/smile
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above regarding validating content_type as test is supposed to be for smile but format is set to cbor

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to be format: smile.

Signed-off-by: dblock <dblock@amazon.com>
@Xtansia Xtansia merged commit 05d5537 into opensearch-project:main Jul 10, 2024
10 of 11 checks passed
@dblock dblock deleted the support-smile branch July 10, 2024 01:00
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.

[FEATURE] Add cat smile format responses w/tests
2 participants