-
Notifications
You must be signed in to change notification settings - Fork 396
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
Fix openapi specification #8273
Fix openapi specification #8273
Conversation
Which tool did you run on the swagger file? |
I used the "OpenAPI (Swagger) Editor," which is a VS Code extension. Also, we can see the same errors on https://editor.swagger.io/. Since the file name is |
Thanks. The file is present in the open source repository but it is written for usage by the closed source control plane. We remove stuff from it that the control plane doesn't use, for example, so it is not a full description of the pageserver's HTTP API. I have asked my colleauges who work on the control plane to have a look on your PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This fixes some obvious typos, and spec is valid, so I think it's good to go. Thanks!
I was a bit concerned about specifying schema for html response, never used it, but it looks like at least Go client was generated without issues.
I opened an internal client PR https://github.com/neondatabase/cloud/pull/15383
07740f6
to
4b15393
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I also messed something up with CI permissions after clicking 'Update with rebase'. Hopefully if you push another commit on your own it will help
Co-authored-by: Arpad Müller <arpad-m@users.noreply.github.com>
3169 tests run: 3048 passed, 0 failed, 121 skipped (full report)Code coverage* (full report)
* collected from Rust tests only The comment gets automatically updated with the latest test results
ebb1598 at 2024-07-19T18:28:51.253Z :recycle: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I manged to generate the client now, so LGTM
OMG, sorry for accidentally closing it. I just referenced it in the private repo as |
## Problem There are some swagger errors in `pageserver/src/http/openapi_spec.yml` ``` Error 431 15000 Object includes not allowed fields Error 569 3100401 should always have a 'required' Error 569 15000 Object includes not allowed fields Error 1111 10037 properties members must be schemas ``` ## Summary of changes Fixed the above errors.
Problem
There are some swagger errors in
pageserver/src/http/openapi_spec.yml
Summary of changes
Fixed above errors.
Checklist before requesting a review
Checklist before merging