[PEP-1898] Document ownerUserIds on company responses#1861
Merged
Conversation
Company responses from the public API now include a read-only ownerUserIds property (codat-internal/public-api#131). Adds a changelog post and a section in the managing-companies guide. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Rewrites the company-owners section in active voice per the Vale Google.Passive findings, and removes the changelog post (and its authors.yml entry) from this PR. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Link check results for preview deployment (https://codat-docs-git-pep-1898-company-owners-docs-codat.vercel.app): |
Rob-Codat
marked this pull request as ready for review
July 21, 2026 10:47
Rob-Codat
enabled auto-merge
July 21, 2026 11:33
brucepouncey
approved these changes
Jul 21, 2026
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
2 participants
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.
PEP-1898 — document company owners on company responses
https://codatdocs.atlassian.net/browse/PEP-1898
The public API is adding a read-only
ownerUserIdsproperty to all company responses (codat-internal/public-api#131) — the IDs of the users assigned as owners of the company, empty when unassigned. This PR documents it:docs/using-the-api/managing-companies.md, covering the read-only property, the empty-array behavior, and that owners are managed in the Codat Portal (the create/update endpoints don't accept the property).The API reference schema is updated separately in codat-internal/oas#66 and flows into
static/oas/here via the pipeline bot — no hand edits to the specs in this PR.Merge timing
Hold until codat-internal/public-api#131 deploys so the docs don't describe a field that isn't returned yet. The Portal owner-assignment UI (PEP-1865 etc.) is still in progress, so the copy references owner management in the Portal without describing specific UI.
🤖 Generated with Claude Code