docs: sync API docs from website#71
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the OpenAPI specification and its generated TypeScript definitions, primarily adjusting internal source line references and refining the description of the provider categories endpoint to mention the shared provider catalog snapshot. Feedback highlights a security concern regarding the exposure of internal file paths and line numbers in the public schema via the x-qveris-source extension. Additionally, a consistency check is requested for the description of the /providers endpoint to align with the changes made to the categories endpoint.
| "x-qveris-source": { | ||
| "file": "backend/routers/auth.py", | ||
| "line": 3150 | ||
| "line": 3157 |
There was a problem hiding this comment.
The x-qveris-source extension exposes internal backend file paths and line numbers in the public API specification. This information leaks internal implementation details and directory structures to external consumers. Consider stripping these internal metadata fields (including x-qveris-response-model) during the generation or sync process for the public-facing schema.
| ], | ||
| "summary": "Get Provider Categories", | ||
| "description": "Get provider categories from the real API", | ||
| "description": "Get provider categories from the shared provider catalog snapshot.", |
There was a problem hiding this comment.
The description for /providers/categories has been updated to mention the 'shared provider catalog snapshot', but the /providers endpoint (line 2027) still refers to the 'real API'. If both endpoints now share the same data source, their descriptions should be updated consistently to avoid confusion for API consumers.
2 participants
Mirrors website-owned REST API, Cookbook, and OpenAPI docs after qveris-website release/test changed. Source run: https://github.com/WonderfulValley/qveris-website/actions/runs/26404205879.