Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update get_doc_url function and set EXTERNAL_DOCS setting for OpenAPI spec #13430

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update get_doc_url function and set EXTERNAL_DOCS setting for OpenAPI spec #13430

wants to merge 6 commits into from

Conversation

walpox
Copy link

@walpox walpox commented Jan 5, 2025

Proposed changes

  • Set the EXTERNAL_DOCS setting for the OpenAPI document.
  • get_doc_url: Return the home page of documentation when the page argument is not provided.

Checklist

  • Lint and unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added documentation to describe my feature.
  • I have squashed my commits into logic units.
  • I have described the changes in the commit messages.

Other information

Relates to #12584

walpox added 4 commits January 5, 2025 01:18
@walpox
feat(get_doc_url): return doc url for root path
ebeeda6
@walpox
docs(api): set external_docs setting
31a574a
@walpox
feat(get_doc_url): change new feature implementation
145b439 
Make returning the home page of the documentation more consistent with
existing code logic and with clearer intent, improving code readability.
@walpox
refactor(get_doc_url): remove redundant code
8335c2c
@nijel nijel added this to the 5.10 milestone Jan 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
5.10
Development

Successfully merging this pull request may close these issues.
2 participants
@walpox @nijel