🤖 Auto-Update: API Documentation OpenAPI Spec - #297
SohamRatnaparkhi wants to merge 1 commit into
Conversation
…2729efa0749c8566610bf09055a8247 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. |
|
| @@ -8512,16 +10351,18 @@ | |||
| }, | |||
| "/context/ingest": { | |||
| "post": { | |||
| "description": "Ingest knowledge documents or memories for a tenant.", | |||
| "description": "Ingest content for a database. `items` is the preferred shape (text or a conversation per item); the deprecated `documents`, `app_knowledge` and `memories` fields are selected by `type`. The same `items` array may also be sent as an application/json body.", | |||
There was a problem hiding this comment.
This description says callers may send an application/json ingest body, but requestBody.content defines only multipart/form-data. OpenAPI renderers and generated SDKs therefore cannot expose the advertised JSON request shape, and the maintained endpoint guide still tells callers not to send JSON. Add an application/json content entry with the unified ingest schema, or remove the JSON-body claim if it is unsupported.
Knowledge Base Used:
| "example": [ | ||
| "team_docs", | ||
| "engineering" | ||
| ], |
There was a problem hiding this comment.
Examples violate their schemas
Several new examples have the wrong JSON type: collections is an object map but uses an array example, credentials is an array but uses an object example at lines 4775–4783, and the boolean upsert uses the string example "true" at lines 5672–5674. These mismatches can produce misleading Mintlify samples and fail schema-example validation. Each example should match its declared type.
Knowledge Base Used: API integration surface
| "description": "Type names the corpus: knowledge (default) or memory.", | ||
| "enum": [ | ||
| "knowledge", | ||
| "memory" | ||
| "memory", | ||
| "all" | ||
| ], |
There was a problem hiding this comment.
The list request now accepts type: "all", but this description still mentions only knowledge and memory, and the maintained List Context guide documents only those two values. Document what all returns and update the guide so callers do not have to guess how combined results are merged, ordered, or scoped.
Knowledge Base Used: API endpoint families
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| "200": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/handler.vaultCredentialRevealResponse" | ||
| } | ||
| } | ||
| }, | ||
| "description": "OK" |
There was a problem hiding this comment.
The credential-reveal operation says its plaintext-secret response must never be cached, but this successful response does not declare a Cache-Control: no-store header. Add that response-header contract so consumers and generated documentation can verify the required handling instead of relying only on prose.
✅ 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: 19f145b · View review on OpenHack
|
Auto-generated from hydradb-application @ 90ba87bf22729efa0749c8566610bf09055a8247 (main).
Merging deploys docs via Mintlify. Review
api-reference/v2/openapi.jsonbefore merging.