Update docs and use scalar UI on top of openapi spec.#177
Merged
PierreLeGuen merged 3 commits intomainfrom Nov 12, 2025
Merged
Conversation
…sioning
* Added interactive API documentation section to README, detailing Scalar UI and OpenAPI Spec endpoints.
* Updated route paths across the API to include versioning ("/v1") for better clarity and future-proofing.
* Refactored Swagger UI handler to serve Scalar API documentation with improved styling and configuration.
* Introduced new tags for OpenAPI documentation to categorize endpoints effectively.
* Removed deprecated tests related to Swagger UI HTML structure.
…iptions * Updated route documentation for attestation, completions, conversations, health, models, organizations, and responses to provide clearer descriptions and improve consistency. * Enhanced response descriptions to better reflect the functionality and expected outcomes of each endpoint. * Added new endpoints for signature retrieval and attestation report, ensuring comprehensive coverage of API capabilities.
* Added detailed documentation for the `get_response`, `delete_response`, `cancel_response`, and `list_input_items` endpoints, enhancing clarity on their functionality and expected outcomes. * Introduced new routes for retrieving, deleting, and canceling responses, as well as listing input items associated with a specific response, improving the API's capabilities and usability. * Updated existing documentation to ensure consistency and accuracy across response-related endpoints.
PierreLeGuen
temporarily deployed
to
Cloud API test env
GitHub Actions
Inactive
Evrard-Nil
approved these changes
Nov 12, 2025
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
2 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.
No description provided.