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.

Sign up for GitHub

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

Jump to bottom

fix: add 1.x compatible endpoints to swagger #19828

Merged
merged 3 commits into from
Oct 29, 2020
Merged

fix: add 1.x compatible endpoints to swagger #19828

merged 3 commits into from
Oct 29, 2020

Conversation

glinton
Copy link
Contributor

@glinton glinton commented Oct 26, 2020

Closes #19753

  • http/swagger.yml updated (if modified Go structs or API)

@glinton glinton requested a review from stuartcarnie October 26, 2020 22:25
@glinton glinton requested a review from a team as a code owner October 26, 2020 22:25
@glinton glinton requested review from joelfried and removed request for a team October 26, 2020 22:25
stuartcarnie
stuartcarnie requested changes Oct 26, 2020
View reviewed changes
Copy link
Contributor

@stuartcarnie stuartcarnie left a comment

Choose a reason for hiding this comment

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

Looks good; just a couple of nits.

To confirm my understanding, changing /write to /api/v2/write is required as it would conflict with /write based at /. You've explicitly overridden the servers object to change the base to / in both cases. I have confirmed this behavior in this spec: http://spec.openapis.org/oas/v3.0.3#path-item-object

@stuartcarnie
Copy link
Contributor

I would recommend you confirm why the tests are failing

@glinton glinton requested a review from stuartcarnie October 28, 2020 21:28
stuartcarnie
stuartcarnie approved these changes Oct 29, 2020
View reviewed changes
Copy link
Contributor

@stuartcarnie stuartcarnie left a comment

Choose a reason for hiding this comment

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

Thanks for working through that – makes sense to separate the v1 compatibility APIs for now, given the CI issues you ran into 👍

@glinton glinton merged commit 8aa3e6a into master Oct 29, 2020
@glinton glinton deleted the fix/19753 branch October 29, 2020 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stuartcarnie stuartcarnie stuartcarnie approved these changes

@121watts 121watts 121watts approved these changes

@joelfried joelfried Awaiting requested review from joelfried

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add 1.x compatibility api endpoints to swagger
3 participants
@glinton @stuartcarnie @121watts