Skip to content

fix(docs): Fixing incorrect Presentation Template JSON schema #546

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
stevenj merged 2 commits into from
Sep 9, 2025
Merged

fix(docs): Fixing incorrect Presentation Template JSON schema #546

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
9042cd9
fix presentation_template JSON schema
Mr-Leshiy Sep 9, 2025
4bf914f
regenerate
Mr-Leshiy Sep 9, 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: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion .../src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion ...c/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion ...c/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion ...rc/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
18 changes: 9 additions & 9 deletions docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,15 +177,20 @@ See `[presentation_templates.md](TODO)`
],
"type": "string"
},
"cardTitle": {
"description": "A title shown to the editor of the card. Not used by the UI.",
"cardTemplate": {
"contentType": "text/html; charset=utf-8; template=handlebars",
"description": "HTML5 defined presentation layout for the card.\nThe data is templated with handlebars, and the data that can be inserted is\nderived from the `requiredDocumentTypes` and available system wide dynamic data.",
"type": "string"
},
"css": {
"cardTemplateCss": {
"contentType": "text/css; charset=utf-8; template=handlebars",
"description": "Optional styling that can be used by the HTML generated from the template for presentation.",
"type": "string"
},
"cardTitle": {
"description": "A title shown to the editor of the card. Not used by the UI.",
"type": "string"
},
"layoutParameters": {
"description": "Parameters which help the front end layout the provided template. To be defined.",
"type": "object"
Expand All @@ -198,11 +203,6 @@ See `[presentation_templates.md](TODO)`
},
"type": "array",
"uniqueItems": true
},
"template": {
"contentType": "text/html; charset=utf-8; template=handlebars",
"description": "HTML5 defined presentation layout for the card.\nThe data is templated with handlebars, and the data that can be inserted is\nderived from the `requiredDocumentTypes` and available system wide dynamic data.",
"type": "string"
}
},
"type": "object",
Expand Down Expand Up @@ -257,7 +257,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/proposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion .../src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ New versions of this document may be published by:
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ classDiagram
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
16 changes: 8 additions & 8 deletions docs/src/architecture/08_concepts/signed_doc/schema/presentation_template.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,20 @@
],
"type": "string"
},
"cardTitle": {
"description": "A title shown to the editor of the card. Not used by the UI.",
"cardTemplate": {
"contentType": "text/html; charset=utf-8; template=handlebars",
"description": "HTML5 defined presentation layout for the card.\nThe data is templated with handlebars, and the data that can be inserted is\nderived from the `requiredDocumentTypes` and available system wide dynamic data.",
"type": "string"
},
"css": {
"cardTemplateCss": {
"contentType": "text/css; charset=utf-8; template=handlebars",
"description": "Optional styling that can be used by the HTML generated from the template for presentation.",
"type": "string"
},
"cardTitle": {
"description": "A title shown to the editor of the card. Not used by the UI.",
"type": "string"
},
"layoutParameters": {
"description": "Parameters which help the front end layout the provided template. To be defined.",
"type": "object"
Expand All @@ -42,11 +47,6 @@
},
"type": "array",
"uniqueItems": true
},
"template": {
"contentType": "text/html; charset=utf-8; template=handlebars",
"description": "HTML5 defined presentation layout for the card.\nThe data is templated with handlebars, and the data that can be inserted is\nderived from the `requiredDocumentTypes` and available system wide dynamic data.",
"type": "string"
}
},
"type": "object",
Expand Down
7 changes: 6 additions & 1 deletion docs/src/architecture/08_concepts/signed_doc/spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ Catalyst ID <a href="https://datatracker.ietf.org/doc/html/rfc3986">URI</a> iden
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down Expand Up @@ -604,8 +604,13 @@ Catalyst ID <a href="https://datatracker.ietf.org/doc/html/rfc3986">URI</a> iden
* Made `payload.nil` non optional with the default value `false`.
* If `payload.nil` is `true` automatically set `"content type"` and `"content-encoding"` fields to `"excluded"`.

#### 0.1.3 (2025-09-09)

* Fixed an invalid 'Presentation Template' [JSON schema][JSON Schema-2020-12].

[CBOR-LFD-ENCODING]: https://www.rfc-editor.org/rfc/rfc8949.html#section-4.2.3
[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
[JSON Schema-2020-12]: https://json-schema.org/draft/2020-12
[RFC9052-CoseSign]: https://datatracker.ietf.org/doc/html/rfc9052#name-signing-with-one-or-more-si
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
[CommonMark]: https://spec.commonmark.org/0.31.2/
Expand Down
2 changes: 1 addition & 1 deletion docs/src/architecture/08_concepts/signed_doc/types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ All Defined Document Types
| --- | --- |
| License | This document is licensed under [CC-BY-4.0] |
| Created | 2024-12-27 |
| Modified | 2025-09-08 |
| Modified | 2025-09-09 |
| Authors | Alex Pozhylenkov <[email protected]> |
| | Nathan Bogale <[email protected]> |
| | Neil McAuliffe <[email protected]> |
Expand Down
4 changes: 2 additions & 2 deletions specs/definitions/presentation_template/presentation_template.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ presentationTemplate: {
type: "object"
description: "Parameters which help the front end layout the provided template. To be defined."
}
template: {
cardTemplate: {
type: "string"
contentType: "text/html; charset=utf-8; template=handlebars"
description: """
Expand All @@ -74,7 +74,7 @@ presentationTemplate: {
derived from the `requiredDocumentTypes` and available system wide dynamic data.
"""
}
css: {
cardTemplateCss: {
type: "string"
contentType: "text/css; charset=utf-8; template=handlebars"
description: """
Expand Down
7 changes: 7 additions & 0 deletions specs/definitions/signed_docs/authors_copyright.cue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,5 +109,12 @@ copyright: #copyrightNotice & {
* If `payload.nil` is `true` automatically set `"content type"` and `"content-encoding"` fields to `"excluded"`.
"""
},
{
version: "0.1.3"
modified: "2025-09-09"
changes: """
* Fixed an invalid 'Presentation Template' JSON schema.
"""
},
]
}
Loading
Loading