Skip to content

Chore adjust swagger for api gateway - #33694

Merged
jesperhodge merged 9 commits into
masterfrom
chore--adjust-swagger-for-api-gateway
Nov 16, 2023
Merged

jesperhodge merged 9 commits into
masterfrom
chore--adjust-swagger-for-api-gateway

Conversation

@jesperhodge

@jesperhodge jesperhodge commented Nov 10, 2023 •

Copy link
Copy Markdown
Contributor
  • added api gateway server to swaggerfile
  • changed swagger routes from .../cms-api/... to .../authoring-api/...

How to test:

  • go to localhost:18010/authoring-api/ui/

Necessary to dos:

  • add AUTHORING_API_URL env variable to edx-internal config (this shouldn't be merged first. Though it shouldn't cause any errors if the env variable is missing, since there is a default value.)

Depends on these PRs, please review as well:
https://github.com/edx/edge-internal/pull/626
https://github.com/edx/edx-internal/pull/9636

Comment thread cms/urls.py Outdated
@@ -347,6 +347,6 @@
# Custom settings are provided in SPECTACULAR_SETTINGS in cms/envs/common.py.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Custom settings are provided in SPECTACULAR_SETTINGS in cms/envs/common.py.
# Custom settings are provided in SPECTACULAR_SETTINGS as environment variables

Also, I know that this is not your doing, but the fact that SPECTACULAR_SETTINGS have to be defined as env variables and can't be overwritten per API is kind of frustrating no?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is. I'm hoping there is a solution somewhere in spectacular for it, so that we can keep our separate swagger ui for the cms api later on after we switch to spectacular completely.

@connorhaugh connorhaugh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a nit and also you have some lint issues

jesperhodge and others added 5 commits November 14, 2023 13:18
Co-authored-by: connorhaugh <49422820+connorhaugh@users.noreply.github.com>
@jesperhodge
jesperhodge merged commit 7fd4c30 into master Nov 16, 2023
@jesperhodge
jesperhodge deleted the chore--adjust-swagger-for-api-gateway branch November 16, 2023 20:39
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants