Skip to content

docs(acl): explain inherited document permissions (ENG-3302) - #338

Closed
adityamishra-hydradb wants to merge 2 commits into
mainfrom
adityamishra/eng-3302-acl-editor
Closed

adityamishra-hydradb wants to merge 2 commits into
mainfrom
adityamishra/eng-3302-acl-editor

Conversation

@adityamishra-hydradb

@adityamishra-hydradb adityamishra-hydradb commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

For humans

Documents the public ACL inheritance contract from ENG-3302.

The access-control guide and metadata references now explain acl_inherit: true, its widening risk, upload refusal, exclusivity with acl, and last-writer-wins behavior.

In one line: API users can distinguish private revocation from explicit connector-resource inheritance.

For agents

  • acl: [] and acl: null remain private revocations.
  • acl_inherit: true removes a connector document's own ACL.
  • acl and acl_inherit cannot appear together.
  • Uploads and sources without connector resource attribution are refused.
  • Connector syncs can replace manual ACL writes because ACL updates are last-writer-wins.

Testing

  • pnpm hygiene:strict — passed.
  • pnpm mintlify validate — passed.
  • No staging or production system was called, read, or written.

Merge order

  1. Application PR.
  2. Dashboard PR.
  3. This documentation PR: merge after the app change reaches prod.

Related pull requests

Decisions taken without review

  • Document inheritance as a separate field, because empty ACL remains private.
  • State that inheritance can widen access, because the resource ACL can be broader.
  • State last-writer-wins behavior, because provider updates can replace manual ACL changes.

@mintlify

mintlify Bot commented Oct 27, 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 Oct 27, 2026, 11:30 PM

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

@github-actions

Copy link
Copy Markdown

✅ Mintlify Hygiene

No issues found.

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

@greptileai review

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

/devin review

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Starting Devin Review.

Devin Review

@openhack-agent

openhack-agent Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

✅ OpenHack Summary

Security review of docs(acl): explain inherited document permissions (ENG-3302). 4 changed files; 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/endpoint/update-source-metadata.mdx (modified)
  • api-reference/v2/openapi.json (modified)
  • essentials/v2/access-control.mdx (modified)
  • essentials/v2/metadata.mdx (modified)

Last reviewed commit: fcba7a1 · 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.

devin-ai-integration[bot]

This comment was marked as resolved.

Signed-off-by: adityamishra-hydradb <321510987+adityamishra-hydradb@users.noreply.github.com>
@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

@greptileai review

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

/devin review

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Starting Devin Review.

Devin Review

@adityamishra-hydradb

Copy link
Copy Markdown
Contributor Author

This PR is replaced by #341. The replacement contains the same changes in one DCO-signed commit. I did not force-push this branch.

@greptile-apps

greptile-apps Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This documentation PR appears safe to merge after the application change reaches production, as the PR requires.

Summary

Documents how to remove a document’s ACL override and resume its connector resource permissions, as requested by ENG-3302.

  • Connector documents can return to their resource permissions with acl_inherit: true.
  • OpenAPI descriptions show placeholder brackets and query separators directly.

No actionable issues were found.

Reviews (1) · Last reviewed commit: "docs(acl): expose inheritance in the API..." · Reviewed by Greptile

This branch was successfully deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant