Skip to content

Add API documentation for account ownership endpoints#402

Open
robzolkos wants to merge 1 commit intobasecamp:masterfrom
robzolkos:docs-account-ownership-json
Open

Add API documentation for account ownership endpoints#402
robzolkos wants to merge 1 commit intobasecamp:masterfrom
robzolkos:docs-account-ownership-json

Conversation

@robzolkos
Copy link
Contributor

@robzolkos robzolkos commented Mar 23, 2026

Summary

Document the JSON account ownership management endpoints added in https://github.com/basecamp/bc3/pull/10043

Changes

  • Add docs for POST /account/people/:person_id/ownership.json
  • Add docs for DELETE /account/people/:person_id/ownership.json
  • Note the account-owner-only permission requirements
  • Document the returned Person JSON and owner flag behavior
  • Add cURL examples for both endpoints

Copilot AI review requested due to automatic review settings March 23, 2026 13:20
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds API documentation for two account ownership management endpoints that were previously implemented. The documentation follows the established pattern used throughout the API documentation, providing clear descriptions of each endpoint's purpose, parameters, return values, and cURL examples.

Changes:

  • Add documentation for POST endpoint to grant account ownership to a person
  • Add documentation for DELETE endpoint to revoke account ownership from a person
  • Add reference link to the Person resource documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants