-
Notifications
You must be signed in to change notification settings - Fork 4.2k
[BD-21] Fix API docs generation and update swagger.yml #25494
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
Conversation
API docs generation was being blocked by missing values in the doc
settings. We wanted to update the swagger.yml to get the toggle state
("/toggles/v0/state/") endpoint in the docs.
|
Thanks for the pull request, @regisb! I've created BLENDED-649 to keep track of it in Jira. More details are on the BD-21 project page. When this pull request is ready, tag your edX technical lead. |
|
I doubt the broken test is related to the changes from this PR. This is ready for review. |
|
jenkins run py38 python |
|
Your PR has finished running tests. There were no failures. |
@robrap Pretty much, yes. The only additional thing I did was to actually run |
robrap
left a comment
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.
@regisb: Oh. I have no idea how the swagger docs work. So, all the changes in docs/swagger.yaml are generated. I didn't understand that. Seems like we should have a job to keep these docs up to date, but that is beyond this PR.
|
EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production. |
|
EdX Release Notice: This PR has been deployed to the production environment. |
API docs generation was being blocked by missing values in the doc
settings. We wanted to update the swagger.yml to get the toggle state
("/toggles/v0/state/") endpoint in the docs.
cc @nedbat and @robrap.