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

Drop application/yaml content type #933

Merged
merged 3 commits into from
Jul 27, 2022

Conversation

haydentherapper
Copy link
Contributor

@haydentherapper haydentherapper commented Jul 21, 2022

This is a breaking change for any clients that are currently requesting
application/yaml.

This is the simplest fix to #593, as openapi randomly switches between
json and yaml responses when no content type is provided.

Fixes #593

Signed-off-by: Hayden Blauzvern [email protected]

Summary

Release Note

Dropped support for YAML content type

Documentation

This is a breaking change for any clients that are currently requesting
application/yaml.

This is the simplest fix to sigstore#593, as openapi randomly switches between
json and yaml responses when no content type is provided.

Fixes sigstore#593

Signed-off-by: Hayden Blauzvern <[email protected]>
@haydentherapper
Copy link
Contributor Author

Looks like there is a difference between how the comments are generated. This should be ok.

@danishhansari
Copy link

hey 👋 when i open a PR there was a dependabot that making unnecessary commit automatically i have mo idea about that please help me i am stuck

@bobcallaway
Copy link
Member

Looks like there is a difference between how the comments are generated. This should be ok.

I think there's one additional thing in the Makefile that needs addressed: --default-consumes application/json\;q=1 should be removed

@bobcallaway
Copy link
Member

hey wave when i open a PR there was a dependabot that making unnecessary commit automatically i have mo idea about that please help me i am stuck

@Ansari-Danish please open a separate issue instead of discussing on an unrelated PR. Thanks!

@haydentherapper
Copy link
Contributor Author

@bobcallaway Updated the Makefile. Any advice on how to handle the client differences due to the comment? Can we just ignore the required check when merging?

@codecov-commenter
Copy link

codecov-commenter commented Jul 24, 2022

Codecov Report

Merging #933 (5b7f32d) into main (cb5572d) will increase coverage by 0.15%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #933      +/-   ##
==========================================
+ Coverage   48.20%   48.35%   +0.15%     
==========================================
  Files          62       61       -1     
  Lines        5398     5383      -15     
==========================================
+ Hits         2602     2603       +1     
+ Misses       2513     2500      -13     
+ Partials      283      280       -3     
Impacted Files Coverage Δ
pkg/sharding/ranges.go 47.27% <ø> (ø)
pkg/client/rekor_client.go 86.95% <100.00%> (ø)
pkg/types/alpine/v0.0.1/entry.go 56.72% <0.00%> (+1.26%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us.

@haydentherapper
Copy link
Contributor Author

@bobcallaway Ran make clean; make, and got the same result.

Signed-off-by: Hayden Blauzvern <[email protected]>
@haydentherapper
Copy link
Contributor Author

Figured it out, I was using go 1.19 and not .18.

@bobcallaway bobcallaway merged commit 4da9b37 into sigstore:main Jul 27, 2022
@github-actions github-actions bot added this to the v1.0.0 milestone Jul 27, 2022
@haydentherapper haydentherapper deleted the drop-yaml branch July 27, 2022 18:36
bobcallaway pushed a commit to bobcallaway/rekor that referenced this pull request Aug 3, 2022
* Drop application/yaml content type

This is a breaking change for any clients that are currently requesting
application/yaml.

This is the simplest fix to sigstore#593, as openapi randomly switches between
json and yaml responses when no content type is provided.

Fixes sigstore#593

Signed-off-by: Hayden Blauzvern <[email protected]>

* remove default-consumes from Makefile

Signed-off-by: Hayden Blauzvern <[email protected]>

* Fix comment generation

Signed-off-by: Hayden Blauzvern <[email protected]>
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.

Rekor API sometimes responds with YAML instead of JSON
4 participants