Repository navigation
🤖 Auto-Update: API Documentation OpenAPI Spec - #343
SohamRatnaparkhi merged 1 commit into
Conversation
…a1599bce293d1032ca8a9384146677d 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: 8766c69 · View review on OpenHack
|
… to autogen - Access Control: a Google Drive-only section on files shared with a group: what google_group_membership_resolves reports, why a false result keeps group-shared files restricted, and the fix (reconnect as a Workspace admin with Directory access). States that no other connector reports it. - Connectors: removing a member, or a member leaving, revokes every key they created in the workspace, and re-inviting restores none. A provider whose acl_supported HydraDB withdraws stops enforcing and keeps enforce_acl. - Update Connector: the 503 when the provider catalog cannot be read while enabling enforce_acl. - api-reference/v2/openapi.json goes back to main. The generated spec (#343) now carries acl_supported, acl_description and enforce_acl from the API's own annotations, so this PR no longer hand-edits it and the two do not conflict. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Soham Ratnaparkhi <soham@hydradb.com>
[Low impact] The PR reaches API reference readers, not server execution. The PR appears safe to merge, with two non-blocking documentation fixes recommended. FindingsSummaryThis update documents connector ACL enforcement, response warnings, connector health details, and Google Group lookup support.
Reviews (1) · Last reviewed commit: "chore(docs): update OpenAPI spec from hy..." · Reviewed by Greptile |
| "warnings": [ | ||
| { | ||
| "code": "acl_ignored_by_connector_enforcement", | ||
| "message": "This connector enforces ACL, so the request's acl was ignored." | ||
| } | ||
| ] |
There was a problem hiding this comment.
Unrelated responses show ACL warnings
The new examples show acl_ignored_by_connector_enforcement on feedback submissions, ingestion, deletion, and other operations that do not read with a request acl. The warnings description limits this notice to enforced reads. These examples make readers expect an ACL override where it does not apply. Keep the warning example on enforced reads and omit it from unrelated responses.
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!
| "properties": { | ||
| "acl": { | ||
| "description": "Principals to query as: emails or `user_email:`, `group:` or `domain:` principals. Returns their context plus public and unrestricted context. Omit, `[]` or `[\"*\"]` for no scoping.", | ||
| "description": "Optional principals for non-enforced connectors. Enforced connectors use the caller and return `acl_ignored_by_connector_enforcement` only when `acl` is supplied.", |
There was a problem hiding this comment.
ACL request instructions disappear
The replacement acl descriptions explain enforced connectors but remove the accepted principal forms and the no-scoping behavior for non-enforced connectors. The relations parameter also loses its repeated-or-comma-separated instructions. Users now need a separate guide to build these requests. Preserve those details alongside the new enforcement caveat.
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!
* docs(connectors): document source permission enforcement (PRO-3222 PRO-3223) Signed-off-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> * fix(docs): validate permission examples (PRO-3222 PRO-3223) Signed-off-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> * fix(docs): clarify ACL behavior outside enforced connectors (PRO-3223) Signed-off-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> * docs(connectors): standardize ACL enforcement terms (PRO-3222 PRO-3223) Signed-off-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> * docs: simplify connector ACL contract Signed-off-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> * docs: correct provider ACL field names Signed-off-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> * docs(connectors): let writers set ACL enforcement (PRO-3222) Signed-off-by: SohamRatnaparkhi <92905626+SohamRatnaparkhi@users.noreply.github.com> Co-authored-by: Soham Ratnaparkhi <soham@hydradb.com> * docs(acl): Drive group membership, key revocation, and leave the spec to autogen - Access Control: a Google Drive-only section on files shared with a group: what google_group_membership_resolves reports, why a false result keeps group-shared files restricted, and the fix (reconnect as a Workspace admin with Directory access). States that no other connector reports it. - Connectors: removing a member, or a member leaving, revokes every key they created in the workspace, and re-inviting restores none. A provider whose acl_supported HydraDB withdraws stops enforcing and keeps enforce_acl. - Update Connector: the 503 when the provider catalog cannot be read while enabling enforce_acl. - api-reference/v2/openapi.json goes back to main. The generated spec (#343) now carries acl_supported, acl_description and enforce_acl from the API's own annotations, so this PR no longer hand-edits it and the two do not conflict. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Soham Ratnaparkhi <soham@hydradb.com> --------- Signed-off-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> Signed-off-by: SohamRatnaparkhi <92905626+SohamRatnaparkhi@users.noreply.github.com> Signed-off-by: Soham Ratnaparkhi <soham@hydradb.com> Co-authored-by: Vorflux AI <249966464+vorflux[bot]@users.noreply.github.com> Co-authored-by: SohamRatnaparkhi <92905626+SohamRatnaparkhi@users.noreply.github.com> Co-authored-by: Soham Ratnaparkhi <soham@hydradb.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Auto-generated from hydradb-application @ 63732238aa1599bce293d1032ca8a9384146677d (main).
Merging deploys docs via Mintlify. Review
api-reference/v2/openapi.jsonbefore merging.Need help on this PR? Tag
@codesmith-botwith what you need.