← Documentation home

Canonical Markdown source · Oct 20, 2018

Linked Art Response Profile Contract

linked-art/response-profile-contract.md · 25 lines · SHA-256 a1c4c7a921be

Status: provisional internal contract

Prepared: July 28, 2026

Linked Art issue: #362

Meta Museum uses two server-defined response shapes while the Linked Art 1.1

profile proposal remains unsettled:

| Internal label | Purpose | Contract |

|---|---|---|

| `brief` | Discovery, lists, and change notifications | Canonical `id`, `type`, optional label/classification/identifier fields, `_complete: false`, and `_links.full.href` pointing to the canonical full record. |

| `full` | Canonical record retrieval | Complete stored representation with no root `_complete: false` marker. |

The brief projection is deliberately bounded. Clients cannot request arbitrary

fields, and both shapes retain the same canonical identity. Existing HAL links

are preserved and the server adds a deterministic `full` link.

These labels describe current implementation behavior. They are not advertised

as final Linked Art 1.1 vocabulary and are not exposed as a new route parameter

before issue #362 is resolved.

Implementation: `src/contracts/linked-art-response-profile.ts`

Contract tests: `tests/contracts/linked-art-response-profile.test.ts`