Document accessRequests API for requesting document access#25
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
accessRequests.*endpoints introduced in outline/outline#10825 ("feat: request document access"), where a user can request access to a document they cannot currently view, and a user with sharing permission can approve or dismiss the request.Adds:
AccessRequeststag.AccessRequestschema component (id,documentId,userId,user,teamId,status,responderId,responder,respondedAt,createdAt,updatedAt).statusis one ofpending,approved,dismissed.{ data: AccessRequest, policies: Policy[] }:POST /accessRequests.create— body{ documentId }.POST /accessRequests.info— body{ id?, documentId? }(at least one required;documentIdlooks up the current user's pending request for that document).POST /accessRequests.approve— body{ id, permission? }wherepermissionis one ofread(default),read_write,admin(matches theDocumentPermissionenum used by the route).POST /accessRequests.dismiss— body{ id }.Other PRs merged in the same window (#12307, #12306, #12305, #12304, #12303, #12301, #12103) are dependency bumps, internal refactors, or non-API changes — no spec updates required.
Test plan
yarn lint(Spectral) passes with no errors.node utils/validateOperationIds.jspasses.spec3.jsonfrom the updated YAML.Generated by Claude Code