Skip to content

fix(docs): system parameters schema and cue definition #335

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.

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

Open
wants to merge 18 commits into
base: feat/signed-doc-spec-0.04
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
15683fa
fix(docs): system parameters schema and cue definition
nathanbogale May 19, 2025
58e1be5
fix(docs): parameter json and cue structure
nathanbogale May 19, 2025
04d8238
fix (docs): decision reference to brand and overall structure
nathanbogale May 19, 2025
cb28dec
fix(docs): cue files fixed - path wip
nathanbogale May 19, 2025
f1ae914
fix(docs): fixed instabilities with the signed document generation
nathanbogale May 20, 2025
4973d39
feat(docs): Add examples for predefined document schemas
stevenj May 20, 2025
fb6b392
Merge branch 'main' into feat/add-payload-examples
stevenj May 20, 2025
e2d902d
Merge branch 'feat/signed-doc-spec-0.04' into feat/add-payload-examples
stevenj May 20, 2025
9feb9a5
Merge branch 'feat/signed-doc-spec-0.04' into feat/system-parameters
stevenj May 21, 2025
757c07a
Merge branch 'feat/add-payload-examples' into feat/system-parameters
nathanbogale May 21, 2025
aae4675
fix(docs): stable document regeneration
nathanbogale May 21, 2025
0023a5e
fix(docs): schema and example updated and stable for brands, campaign…
nathanbogale May 22, 2025
2bc1917
fix(docs): added a central and reusable definition json for schema re…
nathanbogale May 26, 2025
eff33eb
fix(docs): updated template reference and usage
nathanbogale Jun 1, 2025
4758bfb
fix(docs): simplified parameter documents, removed payload
nathanbogale Jun 19, 2025
0b6addd
fix(docs): document regenerated after payload removal
nathanbogale Jun 19, 2025
c4e2fc3
Merge branch 'feat/signed-doc-spec-0.04' into feat/system-parameters
stevenj Jun 21, 2025
719e9ff
fix(docs): added a list of captured parameters
nathanbogale Jun 24, 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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ $RECYCLE.BIN/
!/.vscode/settings.recommended.json
!/.vscode/tasks.recommended.json

venv/
# Python virtual environments

# Dart stuff
/pubspec.lock
/.dart_tool/**/*
Expand Down
26 changes: 2 additions & 24 deletions docs/src/architecture/08_concepts/signed_doc/diagrams/all.dot
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,6 @@ digraph "All" {
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>

</TABLE>
>
Expand Down Expand Up @@ -186,16 +176,6 @@ digraph "All" {
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Campaign Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>

</TABLE>
>
Expand Down Expand Up @@ -437,7 +417,7 @@ digraph "All" {
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters<BR />Campaign Parameters<BR />Category Parameters</I></FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Decision Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
Expand Down Expand Up @@ -963,10 +943,8 @@ digraph "All" {
];


"Campaign Parameters":"parameters":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Category Parameters":"parameters":e -> "Campaign Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Comment Moderation Action":"ref":e -> "Proposal Comment":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"parameters":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Decision Parameters":"parameters":e -> "Decision Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Proposal":"template":e -> "Proposal Template":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Proposal":"parameters":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"ref":e -> "Proposal":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,38 +72,8 @@ Relationships"
>
];


"Campaign Parameters" [
id="Campaign Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters/">
<FONT COLOR="#ffffff"><B> Campaign Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];

}

"Decision Parameters" [
id="Decision Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../decision_parameters/">
<FONT COLOR="#ffffff"><B> Decision Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Proposal" [
id="Proposal";
label=<
Expand Down Expand Up @@ -209,8 +179,6 @@ Relationships"
];


"Campaign Parameters":"title":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment Meta Template":"title":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,6 @@ Relationships"
color=blue
penwidth=20

"Brand Parameters" [
id="Brand Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../brand_parameters/">
<FONT COLOR="#ffffff"><B> Brand Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Campaign Parameters" [
id="Campaign Parameters";
label=<
Expand Down Expand Up @@ -82,53 +67,13 @@ Relationships"
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>

</TABLE>
>
];


"Category Parameters" [
id="Category Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../category_parameters/">
<FONT COLOR="#ffffff"><B> Category Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];

}

"Decision Parameters" [
id="Decision Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../decision_parameters/">
<FONT COLOR="#ffffff"><B> Decision Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Proposal" [
id="Proposal";
label=<
Expand Down Expand Up @@ -234,9 +179,6 @@ Relationships"
];


"Campaign Parameters":"parameters":e -> "Brand Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Category Parameters":"title":e -> "Campaign Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment Meta Template":"title":e -> "Campaign Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,6 @@ Relationships"
color=blue
penwidth=20

"Campaign Parameters" [
id="Campaign Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters/">
<FONT COLOR="#ffffff"><B> Campaign Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Category Parameters" [
id="Category Parameters";
label=<
Expand Down Expand Up @@ -82,38 +67,13 @@ Relationships"
</TABLE>
</TD>
</TR>
<TR>
<TD ALIGN="LEFT" PORT="parameters" BGCOLOR="#e7e2dd">
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Campaign Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
</TR>

</TABLE>
>
];

}

"Decision Parameters" [
id="Decision Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../decision_parameters/">
<FONT COLOR="#ffffff"><B> Decision Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Proposal" [
id="Proposal";
label=<
Expand Down Expand Up @@ -219,8 +179,6 @@ Relationships"
];


"Category Parameters":"parameters":e -> "Campaign Parameters":"title":w [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
"Decision Parameters":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Proposal Comment Meta Template":"title":e -> "Category Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,57 +13,6 @@ Relationships"



subgraph cluster_system_parameters {
label = "System Parameters";
color=blue
penwidth=20

"Brand Parameters" [
id="Brand Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../brand_parameters/">
<FONT COLOR="#ffffff"><B> Brand Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Campaign Parameters" [
id="Campaign Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../campaign_parameters/">
<FONT COLOR="#ffffff"><B> Campaign Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];


"Category Parameters" [
id="Category Parameters";
label=<
<TABLE BORDER="2" COLOR="#29235c" CELLBORDER="1" CELLSPACING="0" CELLPADDING="10">
<TR>
<TD PORT="title" BGCOLOR="#1d71b8" HREF="../category_parameters/">
<FONT COLOR="#ffffff"><B> Category Parameters </B></FONT>
</TD>
</TR>

</TABLE>
>
];

}

"Decision Parameters" [
id="Decision Parameters";
label=<
Expand Down Expand Up @@ -118,7 +67,7 @@ Relationships"
<TABLE CELLPADDING="0" CELLSPACING="0" BORDER="0">
<TR>
<TD ALIGN="LEFT" VALIGN="TOP" WIDTH="200"><FONT COLOR="#7706E5">parameters</FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Brand Parameters<BR />Campaign Parameters<BR />Category Parameters</I></FONT></TD>
<TD ALIGN="RIGHT"><FONT COLOR="#7706E5"><I>Decision Parameters</I></FONT></TD>
</TR>
</TABLE>
</TD>
Expand All @@ -129,5 +78,5 @@ Relationships"
];


"Decision Parameters":"parameters":e -> "Brand Parameters" [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*", lhead="cluster_system_parameters"]
"Decision Parameters":"parameters":e -> "Decision Parameters":"title":n [dir=forward, penwidth=6, color="#29235c", headlabel="1", taillabel="*"]
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

## Description

Parameters which define this brand within the system.
This specification outlines the required definitions for the current features.
The document will be incrementally improved in future iterations as more functionality
and features are added.
This section will be included and updated in future iterations.

<!-- markdownlint-disable max-one-sentence-per-line -->

Expand Down Expand Up @@ -118,9 +121,13 @@ New versions of this document may be published by:

### Changelog

#### 0.01 (2025-04-04)
#### v1 (2024-06-07)

Initial version. Structure aligned with global metadata requirements.

#### v2 (2025-04-04)

* First Published Version
Updated to include common definitions and examples.

[RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1
[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode
Expand Down
Loading
Loading