Skip to content

Commit 8f21898

Browse files
committed
Add a Changelog page mirroring the VDP repo CHANGELOG.
1 parent 284c9f4 commit 8f21898

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

‎docs/changelog.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to the View Descriptor Protocol (VDP) specification are documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). The specification is in early working draft; entries below track changes to the v0.1 draft until its first tagged release.
6+
7+
## [0.1.0] — Working Draft (unreleased)
8+
9+
### Added
10+
11+
- VDP specification (`view-descriptor-protocol.md`): view descriptor format with recursive slots, slot arrays, multiple named views, transport via inline `_view`/`_views` or HTTP `Link` headers (`rel="view-descriptor"`) and the `View-Template` shorthand, OData4 instance annotations, caching and versioning of descriptor resources, client resolution algorithm, error handling, security considerations, discovery (`OPTIONS` headers, `/.well-known/vdp`, OpenAPI `x-vdp` extension), and partial update patterns.
12+
- JSON Schema `vdp.v0-1.schema.json` (draft-07) validating `ViewDescriptor` and `MultiViewDescriptor` payloads, with a `DiscoveryDocument` definition for `/.well-known/vdp`.
13+
- Canonical examples (`examples/vdp-*.json`), validated against the schema in CI.
14+
15+
### Changed
16+
17+
- 2026-07-19 — Discovery document `endpoints` entries now use a `descriptor` field holding the URL of the endpoint's view descriptor resource; the field was previously named `template` although it never held a template URL. The schema's `DiscoveryDocument` definition was updated to match.
18+
- 2026-07-19 — Schema `$id` and `$ref` examples moved from `vdp.dev` to `https://vdprotocol.org/schemas/vdp.v0-1.schema.json`.
19+
- 2026-07-19 — Corrected the relative URL resolution example (Section 5.4): per RFC 3986, references without a leading slash resolve under the base URL's path; the example now uses root-relative paths and notes the distinction.
20+
- 2026-07-19 — Clarified `OPTIONS` discovery (Section 13.1): support is advertised with the `VDP-Support` and `VDP-Version` response headers.
21+
- 2026-07-19 — Editorial clarity pass: rewrote the Static/Dynamic Composition definitions, explained descriptor recursion in the abstract, made the problem statement concrete, and assorted sentence-level fixes.
22+
- 2026-07-18 — Template URLs in examples no longer carry `.html` extensions; templates are format-neutral resources.
23+
24+
### Deprecated
25+
26+
- RVST (Representational View State Transfer), VDP's predecessor, is archived in this repository: schemas under `schemas/`, examples under `examples/example-*.json`, and the unfinished HAL variant draft as `examples/rvst-hal-draft.json`. The VDP specification supersedes RVST.
27+
28+
*[VDP]: View Descriptor Protocol
29+
*[HAL]: Hypertext Application Language
30+
*[RVST]: Representational View State Transfer

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ nav:
4747
- Specification: specification.md
4848
- Schema: schema.md
4949
- Examples: examples.md
50+
- Changelog: changelog.md
5051
- Related Projects: related-projects.md
5152

5253
plugins:

0 commit comments

Comments
 (0)