Skip to content

🤖 Auto-Update: API Documentation OpenAPI Spec - #297

Open
SohamRatnaparkhi wants to merge 1 commit into
mainfrom
auto/update-openapi-90ba87bf22729efa0749c8566610bf09055a8247
Open

SohamRatnaparkhi wants to merge 1 commit into
mainfrom
auto/update-openapi-90ba87bf22729efa0749c8566610bf09055a8247

Conversation

@SohamRatnaparkhi

Copy link
Copy Markdown
Contributor

Auto-generated from hydradb-application @ 90ba87bf22729efa0749c8566610bf09055a8247 (main).
Merging deploys docs via Mintlify. Review api-reference/v2/openapi.json before merging.

…2729efa0749c8566610bf09055a8247

Signed-off-by: hydradb-bot <hydradb-bot@users.noreply.github.com>
@mintlify

mintlify Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
cortex-ai 🟢 Ready View Preview Sep 19, 2026, 5:29 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown

✅ Mintlify Hygiene

No issues found.

@greptile-apps

greptile-apps Bot commented Sep 19, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 4/5

The PR should not merge until the advertised JSON ingestion body is represented in the machine-readable request contract; the remaining findings are documentation-quality corrections.

Findings

  1. P1 JSON ingestion is undefined
  2. P2 Examples violate their schemas
  3. P2 All behavior is undocumented
  4. P2 No-cache contract is missing

Summary

This generated OpenAPI update substantially expands the v2 contract with unified ingestion, database administration, connector lifecycle controls, retrieval diagnostics, entity profiles, credential-vault operations, and additional schema fields. The primary merge blocker is that JSON ingestion is advertised but omitted from the machine-readable request content map.

  • Adds connector pause/resume, plan-cap, and ACL-warning surfaces.
  • Adds database rename and custom-instruction operations.
  • Expands unified context ingestion and retrieval response models.
  • Adds entity-profile, subgraph, and credential-vault routes.
  • Contains several schema/example and supporting-guide inconsistencies.
Diagram
%%{init: {'theme': 'neutral'}}%%
flowchart LR
  Client[API client or generated SDK] --> API[v2 OpenAPI surface]
  API --> Ingest[Unified context ingestion]
  API --> Query[Query, profiles, and subgraphs]
  API --> Connectors[Connector pause, resume, and health]
  API --> Databases[Database lifecycle and instructions]
  API --> Vault[Credential vault]
  Ingest --> Context[Knowledge and memory corpora]
  Query --> Context
  Connectors --> Context
  Databases --> Context
Loading

Reviews (1) · Last reviewed commit: "chore(docs): update OpenAPI spec from hy..."

@@ -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.",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 JSON ingestion is undefined

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:

Comment on lines +4332 to +4335
"example": [
"team_docs",
"engineering"
],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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

Comment on lines +5131 to 5136
"description": "Type names the corpus: knowledge (default) or memory.",
"enum": [
"knowledge",
"memory"
"memory",
"all"
],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 All behavior is undocumented

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!

Comment on lines +11526 to +11534
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/handler.vaultCredentialRevealResponse"
}
}
},
"description": "OK"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 No-cache contract is missing

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-agent

Copy link
Copy Markdown

✅ OpenHack Summary

Security review of 🤖 Auto-Update: API Documentation OpenAPI Spec. 1 changed file; 0 findings at or above the low reporting threshold.

P1: Critical 0   P2: High 0   P3: Medium 0   P4: Low 0

Confidence Score: 5/5

No 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
  • api-reference/v2/openapi.json (modified)

Last reviewed commit: 19f145b · View review on OpenHack


TIP: Mention @openhack-agent in a PR comment to request a review or ask a question. Use @openhack-agent fix all for every finding, or @openhack-agent fix unresolved threads for open review threads only.

@openhack-agent openhack-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpenHack reviewed this commit. See the OpenHack Summary for the confidence score and fix actions.

This branch was successfully deployed

1 active deployment
staging 19f145b3 Deployed Sep 19, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant