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.

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

[Misc] Disable fastapi docs in runtime default action #350

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

brosoul
Copy link
Collaborator

@brosoul brosoul commented Nov 7, 2024

Pull Request Description

Disable fastapi docs in runtime.

image

Currently, it is controlled through environment variables, and in the refactor for issue #319 , startup args will be added to the runtime server.

Related Issues

Resolves: #348

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [API]: Modifications to aibrix's API or interface
  • [CLI]: Changes or additions to the Command Line Interface
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

@brosoul brosoul requested a review from Jeffwan November 7, 2024 12:10
Copy link
Collaborator

@Jeffwan Jeffwan left a comment

Choose a reason for hiding this comment

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

looks good to me. This resolve a security issue. GreaT!

@Jeffwan Jeffwan merged commit aa16fa9 into main Nov 7, 2024
9 checks passed
@Jeffwan Jeffwan deleted the linhui/disable-runtime-fastapi-docs branch November 7, 2024 22:28
gangmuk pushed a commit that referenced this pull request Jan 25, 2025
* fix: disable fastapi docs in runtime default action

* format
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.

Disable fastapi endpoint from sidecar container
3 participants