-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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: swagger docs ref_name conflicts #36189
Conversation
Thanks for the pull request, @navinkarkera! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.
|
58330bb
to
0f77b21
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.
👍 Thank you for your thorough work here @navinkarkera !
- I tested this by running this PR with the updated requirement from fix: errors during swagger api-docs generation openedx-learning#273 in my tutor dev stack.
Watched the CMS logs while loading http://local.openedx.io:8001/api-docs/, and noted that all the errors and warnings that this page used to generate are now gone.
Spot-checked a few of the modified APIs by executing them in the browser. - I read through the code
-
I checked for accessibility issuesN/A - Includes documentation inline where views were excluded from the swagger API docs.
-
User-facing strings are extracted for translationN/A
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
2U Release Notice: This PR has been deployed to the edX production environment. |
1 similar comment
2U Release Notice: This PR has been deployed to the edX production environment. |
* fix: swagger docs ref_name conflicts * fix: swagger auto doc errors * chore: bumps openedx-learning==0.18.2 --------- Co-authored-by: Jillian Vogel <[email protected]>
Description
Fixes following error while rendering automatic swagger docs:
Supporting information
Testing instructions
Note that the page renders now without error.
Deadline
"None" if there's no rush, or provide a specific date or event (and reason) if there is one.
Other information
Include anything else that will help reviewers and consumers understand the change.