Add html_content field to BoardOut schema #270

New issue

Closed

opened 2026-04-13 00:06:13 +00:00 by forgejo_admin · 0 comments

forgejo_admin commented

2026-04-13 00:06:13 +00:00

Contributor

Type

feature

Lineage

Companion to forgejo_admin/pal-e-app#104

Repo

pal-e-api (pal-e-docs)

User Story

As a board viewer, I want to see the board note's content (User Stories, Architecture, Acceptance Criteria) rendered above the kanban columns so I have full context without navigating away.

Context

The BoardOut schema does not include html_content from the board's linked note. The frontend has no way to render board note content. This adds the field to the schema and populates it in _board_to_out().

File Targets

src/pal_e_docs/schemas.py — Add html_content: str | None = None to BoardOut
src/pal_e_docs/routes/boards.py — Populate html_content from board_note.html_content in _board_to_out()

Acceptance Criteria

GET /boards/{slug} returns html_content field
Boards with note content return the HTML string
Boards without content return null

Test Expectations

Existing board tests pass
New field appears in API response

Constraints

Minimal change — one field added to schema, one line in helper

Checklist

Schema updated
Route helper updated
Tests pass

forgejo_admin/pal-e-app#104

### Type feature ### Lineage Companion to forgejo_admin/pal-e-app#104 ### Repo pal-e-api (pal-e-docs) ### User Story As a board viewer, I want to see the board note's content (User Stories, Architecture, Acceptance Criteria) rendered above the kanban columns so I have full context without navigating away. ### Context The `BoardOut` schema does not include `html_content` from the board's linked note. The frontend has no way to render board note content. This adds the field to the schema and populates it in `_board_to_out()`. ### File Targets - `src/pal_e_docs/schemas.py` — Add `html_content: str | None = None` to `BoardOut` - `src/pal_e_docs/routes/boards.py` — Populate `html_content` from `board_note.html_content` in `_board_to_out()` ### Acceptance Criteria - `GET /boards/{slug}` returns `html_content` field - Boards with note content return the HTML string - Boards without content return `null` ### Test Expectations - Existing board tests pass - New field appears in API response ### Constraints - Minimal change — one field added to schema, one line in helper ### Checklist - [ ] Schema updated - [ ] Route helper updated - [ ] Tests pass ### Related - forgejo_admin/pal-e-app#104