Add JSON response format to board publication toggle (#2663)

This commit is contained in:
Rob Zolkos
2026-03-05 20:48:03 -05:00
committed by GitHub
parent e27c0c5fa1
commit e47f2d93eb
5 changed files with 103 additions and 1 deletions
+48 -1
View File
@@ -469,10 +469,13 @@ __Response:__
"email_address": "david@example.com",
"created_at": "2025-12-05T19:36:35.401Z",
"url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7"
}
},
"public_url": "http://fizzy.localhost:3006/897362094/public/boards/aB3dEfGhIjKlMnOp"
}
```
The `public_url` field is only present when the board is published.
### `POST /:account_slug/boards`
Creates a new Board in the account.
@@ -544,6 +547,50 @@ __Response:__
Returns `204 No Content` on success.
## Board Publications
Publishing a board makes it publicly accessible via a shareable link, without requiring authentication. Only board administrators can publish or unpublish a board.
### `POST /:account_slug/boards/:board_id/publication`
Publishes a board, generating a shareable public link.
__Response:__
```
HTTP/1.1 201 Created
```
```json
{
"id": "03f5v9zkft4hj9qq0lsn9ohcm",
"name": "Fizzy",
"all_access": true,
"created_at": "2025-12-05T19:36:35.534Z",
"url": "http://fizzy.localhost:3006/897362094/boards/03f5v9zkft4hj9qq0lsn9ohcm",
"creator": {
"id": "03f5v9zjw7pz8717a4no1h8a7",
"name": "David Heinemeier Hansson",
"role": "owner",
"active": true,
"email_address": "david@example.com",
"created_at": "2025-12-05T19:36:35.401Z",
"url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7"
},
"public_url": "http://fizzy.localhost:3006/897362094/public/boards/aB3dEfGhIjKlMnOp"
}
```
If the board is already published, the existing publication is returned.
### `DELETE /:account_slug/boards/:board_id/publication`
Unpublishes a board, removing public access.
__Response:__
Returns `204 No Content` on success.
## Cards
Cards are tasks or items of work on a board. They can be organized into columns, tagged, assigned to users, and have comments.