Skip to content

fix(docs): update ver field validation specification per #502 #645

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

fix(docs): update ver field validation specification per #502 #645

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2832f6b
fix(specs): update ver field validation specification per #502
nathanbogale Nov 17, 2025
6a5edb7
fix(docs): add missing newline at end of signed_doc.json
nathanbogale Nov 17, 2025
262f169
fix(docs): improve formatting of ver field validation rules in docume…
nathanbogale Nov 17, 2025
0e76864
fix(docs): update ID and version validation rules in signed document …
nathanbogale Nov 17, 2025
ca4d4e1
fix(docs): enhance ID and version validation formatting in signed doc…
nathanbogale Nov 17, 2025
73ae874
fix(docs): enhance formatting of ID validation rules in signed docume…
nathanbogale Nov 17, 2025
404ce15
fix(docs): standardize formatting of ID validation rules in signed do…
nathanbogale Nov 17, 2025
0388666
fix(docs): enhance formatting of ID validation rules in signed docume…
nathanbogale Nov 17, 2025
0b5fd61
fix(docs): correct formatting in metadata template validation descrip…
nathanbogale Nov 17, 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
15 changes: 11 additions & 4 deletions 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 @@ -86,10 +86,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -104,7 +106,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`template`](../metadata.md#template)

Expand Down
15 changes: 11 additions & 4 deletions .../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 @@ -91,10 +91,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -109,7 +111,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

## Payload

Expand Down
15 changes: 11 additions & 4 deletions 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 @@ -87,10 +87,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -105,7 +107,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`template`](../metadata.md#template)

Expand Down
15 changes: 11 additions & 4 deletions ...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 @@ -91,10 +91,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -109,7 +111,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`parameters`](../metadata.md#parameters)

Expand Down
15 changes: 11 additions & 4 deletions 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 @@ -87,10 +87,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -105,7 +107,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`template`](../metadata.md#template)

Expand Down
15 changes: 11 additions & 4 deletions ...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 @@ -91,10 +91,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -109,7 +111,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`parameters`](../metadata.md#parameters)

Expand Down
15 changes: 11 additions & 4 deletions 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 @@ -77,10 +77,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -95,7 +97,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`ref`](../metadata.md#ref)

Expand Down
15 changes: 12 additions & 3 deletions docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

### [`ver`](../metadata.md#ver)

Expand All @@ -106,7 +110,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`revocations`](../metadata.md#revocations)

Expand Down
15 changes: 11 additions & 4 deletions docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -128,7 +130,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`ref`](../metadata.md#ref)

Expand Down
15 changes: 11 additions & 4 deletions 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 @@ -147,10 +147,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -165,7 +167,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`ref`](../metadata.md#ref)

Expand Down
15 changes: 11 additions & 4 deletions 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 @@ -87,10 +87,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -105,7 +107,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`template`](../metadata.md#template)

Expand Down
15 changes: 11 additions & 4 deletions ...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 @@ -91,10 +91,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -109,7 +111,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`parameters`](../metadata.md#parameters)

Expand Down
15 changes: 11 additions & 4 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 @@ -89,10 +89,12 @@ timestamp of when the document was created.

#### [`id`](../metadata.md#id) Validation

IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with
[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist.
The document ID validation is performed based on timestamp thresholds:

### [`ver`](../metadata.md#ver)
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
current time.
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
current time.

<!-- markdownlint-disable MD033 -->
| Parameter | Value |
Expand All @@ -107,7 +109,12 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]

#### [`ver`](../metadata.md#ver) Validation

The document version must always be >= the document ID.
1. The document version must always be >= the document ID.
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
the latest known submitted version for that `id`.
4. When a document with the same `id` already exists, the new document's `type` must be the same as
the latest known submitted document's `type` for that `id`.

### [`parameters`](../metadata.md#parameters)

Expand Down
Loading
Loading