Skip to content

Conversation

@regisb
Copy link
Contributor

@regisb regisb commented Nov 2, 2020

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.

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.
@openedx-webhooks
Copy link

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.

@openedx-webhooks openedx-webhooks added blended PR is managed through 2U's blended developmnt program needs triage labels Nov 2, 2020
@regisb
Copy link
Contributor Author

regisb commented Nov 2, 2020

I doubt the broken test is related to the changes from this PR. This is ready for review.

@robrap
Copy link
Contributor

robrap commented Nov 2, 2020

jenkins run py38 python

@edx-status-bot
Copy link

Your PR has finished running tests. There were no failures.

@robrap
Copy link
Contributor

robrap commented Nov 2, 2020

@regisb: Is this PR the minimum required to fix? If not, could we have a PR for that and separate out any additions/improvements?
@nedbat: Could you or someone from @edx/teaching-and-learning review this?

@regisb
Copy link
Contributor Author

regisb commented Nov 3, 2020

Is this PR the minimum required to fix?

@robrap Pretty much, yes. The only additional thing I did was to actually run make api-docs, which made sense in this context (IMHO).

Copy link
Contributor

@robrap robrap left a 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.

@robrap robrap merged commit 64a162f into openedx:master Nov 3, 2020
@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blended PR is managed through 2U's blended developmnt program merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants