Document joining an all-access project (POST /buckets/:id/admissions.json) - #437
Open
jeissonneira wants to merge 1 commit into
Open
Document joining an all-access project (POST /buckets/:id/admissions.json)#437jeissonneira wants to merge 1 commit into
jeissonneira wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
Documents how users can join eligible all-access projects through the admissions endpoint.
Changes:
- Adds the endpoint to the people API index.
- Documents success, authorization failures, discovery limitations, and cURL usage.
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ``` | ||
| <!-- END PUT /projects/1/people/users.json --> | ||
|
|
||
| Join a project |
Contributor
Author
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
sections/people.mddocumentingPOST /buckets/:id/admissions.json— the current person joins a project whoseadmissionspolicy allows it (all-access:teamoremployee)201 Createdempty-body success, the403 Forbidden/ "You must first seek admission" case for invite-only projects and clients onteamprojects, and whyGET /projects.jsoncan't surface a joinable project (it lists only projects you've already joined, so the ID has to come from a URL, a dashboard, or an admin)Notes for maintainers
I ran into this building an agent against the API. The projects it needed were all-access, so it should have been able to reach them — but
GET /projects.jsonreturns only projects you've already joined, so those projects were simply invisible to it, and nothing in the docs says how to join one. The fix was manual every time: either I joined the project on the agent's behalf, or someone drove the web UI to do it.POST /buckets/:id/admissions.jsondoes exactly this, and it's been working well for us — the agent now admits itself to an all-access project instead of waiting on a person. Right now the docs coveradmissionsonly as a policy you set on a project (Update a project), never as something a person can act on, so this fills in the other half.The wording is a proposal — reshape it however fits. One process note: I don't have bc3 access, so this is a hand-edit against the mirror rather than
script/api/sync_to_bc3_apioutput. Happy for it to be treated as a content proposal fordoc/api/and overwritten by the next sync.