Skip to content

Document account API endpoints#389

Open
robzolkos wants to merge 4 commits intobasecamp:masterfrom
robzolkos:api-account-resource
Open

Document account API endpoints#389
robzolkos wants to merge 4 commits intobasecamp:masterfrom
robzolkos:api-account-resource

Conversation

@robzolkos
Copy link

@robzolkos robzolkos commented Mar 12, 2026

Summary

  • Add new sections/account.md documenting the account resource
  • GET /account.json — retrieve account details (owners see additional frozen/paused fields)
  • PUT /account/name.json — rename the account (owner only, 403 for non-owners, 422 for blank names)
  • PUT /account/logo.json — upload or replace the account logo via multipart upload (admin/owner only, validates format and 5 MB size limit)
  • DELETE /account/logo.json — remove the account logo (admin/owner only)
  • Add Account to the README endpoint index

See basecamp/bc3#9920, basecamp/bc3#9928

Add GET /account.json and PUT /account/name.json endpoints covering
account details retrieval and renaming. Owners see additional frozen
and paused fields. Renaming requires owner access and rejects blank
names.
Copilot AI review requested due to automatic review settings March 12, 2026 15:50
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

Adds documentation for the Account API endpoints and links it from the main endpoint index so API consumers can discover and use the new account read/rename functionality.

Changes:

  • Add new sections/account.md documenting GET /account.json and PUT /account/name.json with example payloads and cURL.
  • Add “Account” to the API endpoint index in README.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
sections/account.md New documentation for account retrieval and renaming endpoints, including example request/response bodies.
README.md Adds the Account docs link to the endpoint index for discoverability.

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

You can also share your feedback on Copilot code review. Take the survey.

Use "current access token" instead of "current authenticated session"
and document that the logo field is omitted when no logo is configured.
Add PUT /account/logo.json and DELETE /account/logo.json endpoints
for multipart logo upload and removal. Update logo JSON in existing
account examples to match the actual jbuilder output.
Copilot AI review requested due to automatic review settings March 12, 2026 17:19
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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.


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

You can also share your feedback on Copilot code review. Take the survey.

Align example download_url values with the convention used in
attachments and campfires docs.
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