swagger.yaml: find and fix any gaps#3761
Merged
MuhammadKhalilzadeh merged 1 commit intodevelopfrom Apr 21, 2026
Merged
Conversation
- Remove 13 swagger entries for commented-out/disabled routes:
- POST/PUT/DELETE /assessments (write operations disabled)
- POST /assessments/saveAnswers, PUT /assessments/updateAnswers/{id}
- POST/PATCH/DELETE /questions (write operations disabled)
- POST/PUT/DELETE /roles (write operations disabled)
- DELETE /organizations/{id} (disabled)
- GET /users/by-email/{email} (disabled)
- Add 6 missing policy-linked endpoints:
- GET /policy-linked
- GET/POST/DELETE /policy-linked/{policyId}/linked-objects
- DELETE /policy-linked/risk/{riskId}/unlink-all
- DELETE /policy-linked/evidence/{evidenceId}/unlink-all
- Add 4 missing evaluation-llm-keys endpoints:
- GET/POST /evaluation-llm-keys
- POST /evaluation-llm-keys/verify
- DELETE /evaluation-llm-keys/{provider}
- Add missing model-inventory-change-history/{id} endpoint
Co-Authored-By: Claude Opus 4.6 <[email protected]>
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
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.
(swagger.yaml) in-depth to find and fix any gaps
Provide a concise description of the changes made and their intended purpose.
Write your issue number after "Fixes "
Enter the corresponding issue number after "Fixes #"
Please ensure all items are checked off before requesting a review:
API Documentation Audit - Summary
Branch:
mo-337-april-21-completing-api-docsCommit:
67c07c4efDate: 2026-04-21
Task
Review the codebase and API docs (swagger.yaml) in-depth to find and fix any gaps between the documented API and the actual route implementations.
Methodology
Servers/swagger.yamlServers/routes/Findings & Fixes
Removed 13 disabled endpoints from swagger
These endpoints were documented in swagger but their routes are commented out in the codebase:
Added 11 missing endpoints to swagger
These routes are active in the codebase but were not documented:
Intentionally undocumented (proxy routes)
These routes proxy requests to external Python services and are excluded from the Node.js swagger:
/api/deepeval- proxy to Python EvalServer/api/ai-gateway- proxy to Python AI Gateway/v1- OpenAI-compatible virtual key proxyVerification
yamljsparser