Repository navigation
docs(v2): API reference cleanup and working examples (2/3) - #310
Conversation
Signed-off-by: SohamRatnaparkhi <soham@hydradb.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 docs(v2): API reference and response corrections (2/3). 52 changed files; 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: e75296c · View review on OpenHack
|
![openhack-agent[bot]](https://avatars.githubusercontent.com/in/2637932?s=60&v=4){kind=small}
Read every API Reference page and api-results line by line, keeping the original voice and cutting only repetition and wrong claims: - Query: drop the alias Note and the Default Behaviors block that restated the field table; split the indexing and collection-scope advice; link Recommended configurations by name. - Query overview: new description, removed the duplicate Tip, and the personalized recipe now says to list both collections when shared docs live elsewhere. Thinking mode always includes graph context. - Submit Feedback: removed a Note that repeated the field rules. - Error Responses: removed the E6001 Note that repeated the table, and the troubleshooting bullet no longer names the deprecated tenant_metadata. - Labels end with colons throughout. Connector and webhook pages were read and left as they are. Refs PRO-2457 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
045b2cf to
62b470f
Compare
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review the current head, including the V2 OpenAPI changes. |
 [Medium impact] The changes since the last review appear safe to merge. SummaryCleans up the V2 API reference, updates the public OpenAPI contract, and adds checks for schema references and handwritten examples.
Reviews (23) · Last reviewed commit: "docs(v2): retain combined list and delet..." · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
This comment has been minimized.
This comment has been minimized.
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review the current head.
Mintlify validation, MDX/frontmatter, Python/JSON parsing, and local schema reference checks pass. |
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please reassess the current head and the inline responses. The fetch schema now accepts the null fields emitted by content and URL modes; those samples pass schema validation. SDK route and separate Guides-scope findings have implementation evidence in their threads. |
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
|
@greptileai Please review current head 4d42afe. This pass explains context and chunks before advanced terms, clarifies relationship/subgraph terminology, and keeps the full API Results response reference in an expandable section before the prompt-formatting examples. It preserves request examples and endpoint contracts. Local build validation and hosted validation, hygiene, and link checks pass. |
Most integrations are create database, ingest, check status, query. The sidebar now opens with a "Start here" group holding exactly those four endpoints and the overview, and the overview page leads with the same four calls before the endpoint groups and the full inventory. The resource groups still list every endpoint, so browsing by resource works as before. SDKs and Error Responses move to a Reference group. Refs PRO-2457 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
Signed-off-by: SohamRatnaparkhi <soham@hydradb.com>
4ad0379 to
cac3ba5
Compare
This branch was successfully deployed
1 participant
The V2 API reference exposed unreleased controls, described nested responses as opaque objects, and repeated long explanations. This PR corrects the public contract and makes the endpoint pages easier to scan.
metadataandmetadata_filters. Hide unlaunchedattributes, graph pruning and temporal intent controls, and internal query source blocks.The application source change is hydradb-application#2552. Its shared export policy produces this exact OpenAPI snapshot. Merge that source PR first so future generation preserves these corrections.
Validation passed for all 53 V2 API pages in the browser, 44 endpoint bindings, 81 JSON examples, and 58 response shapes. Affected pages were rechecked after each correction, including the two pages that retain combined list/delete requests. Mintlify build and hygiene pass. No V2 link or anchor errors were found; four pre-existing V1/archive anchor warnings remain outside this change.
Full TypeScript SDK generation and generated-code checks passed with the pinned generator in an isolated setup using a smaller Node heap. Ten Python/TypeScript helper tests pass, including real generated serialization, null preservation, and provider authentication over local HTTP. The repository generator configuration is unchanged. No SDK was published. Browser and SDK evidence are committed under
.audit/.Earlier production testing in this PR covered the 44 V2 operations using cURL and SDK 2.1.7 with authenticated GitHub connector fixtures. That is separate from this final schema and browser pass. Slack authentication and a real OpenAI model call remain unverified.
V2 only. Sidebar shortcuts are separate in #325. Part of PRO-2457.