Skip to content

feat: adds description field to overlay info object #233

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
lornajane merged 2 commits into from
Nov 16, 2025
Merged

feat: adds description field to overlay info object #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
def93d3
feat: adds description field to overlay info object
baywet Nov 5, 2025
bb9e04d
tests: updates minimal test to increase schema coverage
baywet Nov 5, 2025
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
2 changes: 2 additions & 0 deletions schemas/v1.1-dev/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ $defs:
type: string
version:
type: string
description:
type: string
required:
- title
- version
Expand Down
1 change: 1 addition & 0 deletions tests/v1.1-dev/pass/minimal.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ overlay: 1.1.0
info:
title: Minimal
version: 1.0.0
description: A minimal valid overlay specification.
actions:
- target: '$' # Root of document
1 change: 1 addition & 0 deletions versions/1.1.0-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ The metadata MAY be used by the clients if needed.
| ---- | :----: | ---- |
| <a name="info-title"></a>title | `string` | **REQUIRED**. A human readable description of the purpose of the overlay. |
| <a name="info-version"></a>version | `string` | **REQUIRED**. A version identifier for indicating changes to the Overlay document. |
| <a name="info-description"></a>description | `string` | A description of the Overlay Document. [[CommonMark]] syntax MAY be used for rich text representation. |

This object MAY be extended with [Specification Extensions](#specification-extensions).

Expand Down