🤖 Auto-Update: API Documentation OpenAPI Spec - #303
SohamRatnaparkhi wants to merge 1 commit into
Conversation
…7492d091ac8c1f90bc0f190bd3d09c8 Signed-off-by: hydradb-bot <hydradb-bot@users.noreply.github.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
✅ Mintlify HygieneNo issues found. |
✅ OpenHack SummarySecurity review of 🤖 Auto-Update: API Documentation OpenAPI Spec. 1 changed file; 0 findings at or above the low reporting threshold. Confidence Score: 5/5No reportable security findings were detected in this scan. Security merge-readiness rubric: 1 = critical, 2 = high, 3 = medium, 4 = low, 5 = no reportable findings. This score reflects scan findings, not a guarantee of correctness or complete coverage. Files Needing Attention: None Important Files Changed
Last reviewed commit: 5bb26ff · View review on OpenHack
|
|
| "oneOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/search.V2RetrievalResult" | ||
| }, | ||
| { | ||
| "$ref": "#/components/schemas/search.QueryResult" | ||
| } |
There was a problem hiding this comment.
A valid four-key /query response satisfies both branches of this oneOf. search.QueryResult requires those four keys, while search.V2RetrievalResult has no required fields and permits unknown properties. Because oneOf requires exactly one match, conforming validators and generated clients can reject or fail to decode ordinary /query responses. Make the variants mutually exclusive or use a non-exclusive union.
| "example": [ | ||
| "team_docs", | ||
| "engineering" | ||
| ], | ||
| "type": "object" |
There was a problem hiding this comment.
Several newly generated examples do not match their declared schemas: collections is an object but is shown as an array, credentials is an array but is shown as an object, context is an array but is shown as a string, and boolean upsert is shown as "true". These examples feed the published API reference and can lead users or generated examples to send structurally invalid values. Update the generator annotations so each example conforms to its schema.
Auto-generated from hydradb-application @ 6a9e3873a7492d091ac8c1f90bc0f190bd3d09c8 (staging).
Merging deploys docs via Mintlify. Review
api-reference/v2/openapi.jsonbefore merging.