Skip to content

Document data model conventions in CLAUDE.md #786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coroiu merged 6 commits into from
Mar 12, 2026
+22 −0
Merged

Document data model conventions in CLAUDE.md #786

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3091432
docs: add section on data modelling
coroiu Feb 23, 2026
8778edc
remove comment about old usages
coroiu Feb 23, 2026
c02a238
docs: add data model conventions to CLAUDE.md
coroiu Feb 23, 2026
ca607ec
docs: align create vs edit rule to unconditional
coroiu Feb 23, 2026
2ef3951
docs: revert to conditional create vs edit rule
coroiu Feb 23, 2026
2dec1dc
fix: domain model role description
coroiu Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .claude/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,28 @@ Monorepo crates organized in **four architectural layers**:
- TypeScript compilation tested against `clients` repo on PR
- Document migration path for clients

### Data Model Conventions

The SDK uses distinct model layers; use the correct type for the context. See the
[data models docs](https://contributing.bitwarden.com/architecture/sdk/data-models) for the full
picture.

| Suffix | Role | Example |
| ---------- | --------------------------------------------------------------------------------- | ------------------------ |
| _(none)_ | Server/storage-layer model — prefer `View`/`Request`/`Response` at API boundaries | `Cipher`, `Send` |
| `View` | Decrypted DTO returned to clients | `CipherView`, `SendView` |
| `Request` | Public input DTO from client into SDK | `CipherCreateRequest` |
| `Response` | Public output DTO from SDK to client | `LoginResponse` |

**Create vs. Edit requests**: When the fields for creating and editing an item differ (e.g. edit
requires an `id`, `revision_date`, or fields that are immutable after creation), use **separate**
`*CreateRequest` and `*EditRequest` structs.

**Variant data**: When a model has a type discriminant with per-variant associated data (e.g. a send
is either a file or text, never both), use an enum with associated data rather than a bare
discriminant field alongside multiple `Option` fields. The mapping from server wire format (numeric
discriminant + optional fields) belongs at the API→domain boundary.

## Development Workflow

**Build & Test:**
Expand Down
Loading