Skip to content

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

Open
SohamRatnaparkhi wants to merge 1 commit into
mainfrom
auto/update-openapi-6a9e3873a7492d091ac8c1f90bc0f190bd3d09c8
Open

SohamRatnaparkhi wants to merge 1 commit into
mainfrom
auto/update-openapi-6a9e3873a7492d091ac8c1f90bc0f190bd3d09c8

Conversation

@SohamRatnaparkhi

Copy link
Copy Markdown
Contributor

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

…7492d091ac8c1f90bc0f190bd3d09c8

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

mintlify Bot commented Sep 23, 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 23, 2026, 5:18 PM

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

@github-actions

Copy link
Copy Markdown

✅ Mintlify Hygiene

No issues found.

@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: 5bb26ff · 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.

@greptile-apps

greptile-apps Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 4/5

The PR should not merge until the /query response variants are made mutually exclusive, since valid four-key responses currently violate the published oneOf contract.

Findings

  1. P1 Response Variants Overlap
  2. P2 Examples Contradict Schemas

Summary

This automated update synchronizes the v2 OpenAPI contract with the application, adding and revising database, connector, ingestion, query, profile, credential-vault, and graph APIs.

  • Adds unified context ingestion and expanded query response models.
  • Adds connector pause/resume, credential-vault, database rename/instructions, and profile/subgraph operations.
  • Updates filtering, storage-layout, ACL-warning, plan-cap, and deprecation documentation.
  • Greptile automatically discovered a related ticket that helped explain the purpose of this PR: keeping the Go-generated OpenAPI specification reliably synchronized with the Mintlify documentation repository.

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

Comment on lines +2179 to +2185
"oneOf": [
{
"$ref": "#/components/schemas/search.V2RetrievalResult"
},
{
"$ref": "#/components/schemas/search.QueryResult"
}

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 Response Variants Overlap

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.

Comment on lines +4357 to +4361
"example": [
"team_docs",
"engineering"
],
"type": "object"

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 Contradict Schemas

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.

This branch was successfully deployed

1 active deployment
staging 5bb26ff1 Deployed Sep 23, 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