Skip to content

Improve Docs#7

Open
doluk wants to merge 1 commit intoClashKingInc:masterfrom
doluk:improve_docs
Open

Improve Docs#7
doluk wants to merge 1 commit intoClashKingInc:masterfrom
doluk:improve_docs

Conversation

@doluk
Copy link

@doluk doluk commented Jan 31, 2025

This pull request includes changes to the main.py file to enhance the API documentation and improve the overall user experience. The most important changes include adding metadata to the FastAPI application, updating the private API documentation endpoints, and removing the custom OpenAPI function.

Enhancements to API documentation:

  • main.py: Added title, description, and version metadata to the FastAPI application to provide more context about the API.

Updates to private API documentation endpoints:

  • main.py: Updated the /private/docs endpoint to include a custom favicon for the Swagger UI.
  • main.py: Added a new /private/redoc endpoint to serve the ReDoc documentation with a custom favicon.

Removal of custom OpenAPI function:

  • main.py: Removed the custom_openapi function and replaced it with new /docs and /redoc endpoints to override the default documentation with custom titles and favicons.…etup and adding favicos

@sonarqubecloud
Copy link

@doluk doluk requested a review from MagicTheDev February 4, 2025 08:35
@coolify-clash-king
Copy link

coolify-clash-king bot commented Aug 10, 2025

The preview deployment is ready. 🟢

Open Preview | Open Build Logs

Last updated at: 2025-08-10 22:18:55 CET

@coolify-clash-king
Copy link

coolify-clash-king bot commented Aug 10, 2025

The preview deployment is ready. 🟢

Open Preview | Open Build Logs

Last updated at: 2025-09-25 02:51:32 CET

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.

1 participant