Skip to content

Add board settings fields to board JSON responses#2788

Open
robzolkos wants to merge 1 commit intobasecamp:mainfrom
robzolkos:board-settings-read-parity
Open

Add board settings fields to board JSON responses#2788
robzolkos wants to merge 1 commit intobasecamp:mainfrom
robzolkos:board-settings-read-parity

Conversation

@robzolkos
Copy link
Copy Markdown
Contributor

Summary

Add board settings read parity to GET /boards/:id.json.

What changed

  • add public_description and public_description_html to board show JSON
  • add user_ids for boards with granular access (all_access: false)
  • add controller tests covering public description fields, granted user_ids, and omission of user_ids for all-access boards
  • update docs/API.md to document the enriched board response

Notes

  • user_ids matches the existing board update API shape and can be resolved via GET /:account_slug/users
  • the new fields are only added to board show JSON, not the shared board partial
  • user_ids is only present when all_access is false

Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

Copilot AI review requested due to automatic review settings April 2, 2026 21:59
Copy link
Copy Markdown
Contributor

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 enriched board JSON responses by including public_description, public_description_html, and user_ids fields in the GET /boards/:id.json endpoint. The changes align with the existing board update API shape and add comprehensive test coverage along with updated documentation.

Changes:

  • Added public_description and public_description_html fields to board show JSON responses
  • Added conditional user_ids field (only present when all_access: false)
  • Added comprehensive controller tests covering the new fields and their conditional inclusion
  • Updated API documentation with example response showing the new fields and conditional field behavior

Reviewed changes

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

File Description
test/controllers/boards_controller_test.rb Added three tests: one for public_description fields, one for user_ids when board is not all access, and one ensuring user_ids is excluded for all-access boards
docs/API.md Updated board show endpoint documentation with new fields in example response and clarified conditional field behavior
app/views/boards/show.json.jbuilder Added public_description, public_description_html, and conditional user_ids fields

💡 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