feat: add GH workflow to generate openapi schema - #39025
Open
Faraz32123 wants to merge 2 commits into
Open
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Add GH workflow to automatically generate openapi schema whenever view file tagged with the "openedx-platform-sdk" @extend_schema tag changes
Faraz32123
force-pushed
the
feat/add_workflow_to_automatically_generate_openapi_schema
branch
from
August 25, 2026 13:09
b5c8f71 to
69a3dd8
Compare
taimoor-ahmed-1
approved these changes
Sep 2, 2026
feanil
reviewed
Sep 8, 2026
|
|
||
| - name: Install dependencies | ||
| run: | | ||
| pip install --upgrade pip |
Contributor
There was a problem hiding this comment.
We're using uv in this repo now, see how we do this in other workflows and sync it up.
| --file cms_schema.yml | ||
|
|
||
| - name: Open pull request if schemas changed | ||
| uses: peter-evans/create-pull-request@v6 |
Contributor
There was a problem hiding this comment.
This PR should tag the current on-call engineer via the @openedx/wg-maintenance-openedx-platform-oncall team.
| # Switch to a lighter settings module if production settings require | ||
| # environment variables or external services that are unavailable in CI. | ||
| python manage.py spectacular \ | ||
| --settings=lms.envs.production \ |
Contributor
There was a problem hiding this comment.
Is there a reason this can't use the default settings file? Today it's the devstack settings file.
feanil
reviewed
Sep 9, 2026
|
|
||
| **Do not edit these files by hand** — they will be overwritten on the next run. | ||
|
|
||
| @openedx/wg-maintenance-openedx-platform-oncall heads up on this automated PR. |
Contributor
There was a problem hiding this comment.
Use team-reviewers parameter instead: https://github.com/peter-evans/create-pull-request
Comment on lines
+17
to
+37
| push: | ||
| branches: | ||
| - master | ||
| paths: | ||
| # Triggers whenever a view file tagged with the openedx-platform-sdk | ||
| # @extend_schema tag changes — add new tagged view paths here as more | ||
| # APIs are onboarded to the SDK. | ||
| # | ||
| # LMS — Enrollment v2 | ||
| - 'openedx/core/djangoapps/enrollments/**' | ||
| # CMS — XBlock v1, Home v3/v4, Course Details v3, Authoring Grading v3 | ||
| - 'cms/djangoapps/contentstore/rest_api/v1/views/xblock.py' | ||
| - 'cms/djangoapps/contentstore/rest_api/v3/views/home.py' | ||
| - 'cms/djangoapps/contentstore/rest_api/v3/views/course_details.py' | ||
| - 'cms/djangoapps/contentstore/rest_api/v3/views/authoring_grading.py' | ||
| - 'cms/djangoapps/contentstore/rest_api/v4/views/home.py' | ||
| # drf-spectacular config changes in either service | ||
| - 'lms/lib/spectacular.py' | ||
| - 'cms/lib/spectacular.py' | ||
| - 'lms/envs/common.py' | ||
| - 'cms/envs/common.py' |
Contributor
There was a problem hiding this comment.
Rather than running this on every change to these files, what about running this once weekly on any changes. That way we don't need to maintain a list of files here, any changes to any of our tagged schemas will get picked up.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add GH workflow to automatically generate openapi schema whenever view file tagged with the "openedx-platform-sdk" @extend_schema tag changes.
Related PR: edly-io/openedx-platform-sdk#1