Skip to content

Commit 404ce15

Browse files
nathanbogalenathanbogale
committed
fix(docs): standardize formatting of ID validation rules in signed document metadata
- Refine formatting for ID validation rules across multiple documentation files to enhance readability and consistency. - Ensure timestamp threshold criteria are clearly presented for both future and past limits. - Update the signed_doc.json specification to reflect the improved formatting standards.
1 parent 73ae874 commit 404ce15

27 files changed

+117
-142
lines changed

‎docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ timestamp of when the document was created.
8787
#### [`id`](../metadata.md#id) Validation
8888

8989
The document ID validation is performed based on timestamp thresholds:
90-
9190
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9291
current time.
9392
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -109,9 +108,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
109108
1. The document version must always be >= the document ID.
110109
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
111110
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
112-
the latest known submitted version for that `id`.
111+
the latest known submitted version for that `id`.
113112
4. When a document with the same `id` already exists, the new document's `type` must be the same as
114-
the latest known submitted document's `type` for that `id`.
113+
the latest known submitted document's `type` for that `id`.
115114

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

‎docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,10 @@ timestamp of when the document was created.
9292
#### [`id`](../metadata.md#id) Validation
9393

9494
The document ID validation is performed based on timestamp thresholds:
95-
9695
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
97-
current time.
96+
current time.
9897
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
99-
current time.
98+
current time.
10099

101100
<!-- markdownlint-disable MD033 -->
102101
| Parameter | Value |
@@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
114113
1. The document version must always be >= the document ID.
115114
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
116115
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
117-
the latest known submitted version for that `id`.
116+
the latest known submitted version for that `id`.
118117
4. When a document with the same `id` already exists, the new document's `type` must be the same as
119-
the latest known submitted document's `type` for that `id`.
118+
the latest known submitted document's `type` for that `id`.
120119

121120
## Payload
122121

‎docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ timestamp of when the document was created.
8888
#### [`id`](../metadata.md#id) Validation
8989

9090
The document ID validation is performed based on timestamp thresholds:
91-
9291
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9392
current time.
9493
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -110,9 +109,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
110109
1. The document version must always be >= the document ID.
111110
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
112111
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
113-
the latest known submitted version for that `id`.
112+
the latest known submitted version for that `id`.
114113
4. When a document with the same `id` already exists, the new document's `type` must be the same as
115-
the latest known submitted document's `type` for that `id`.
114+
the latest known submitted document's `type` for that `id`.
116115

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

‎docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,6 @@ timestamp of when the document was created.
9292
#### [`id`](../metadata.md#id) Validation
9393

9494
The document ID validation is performed based on timestamp thresholds:
95-
9695
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9796
current time.
9897
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
114113
1. The document version must always be >= the document ID.
115114
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
116115
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
117-
the latest known submitted version for that `id`.
116+
the latest known submitted version for that `id`.
118117
4. When a document with the same `id` already exists, the new document's `type` must be the same as
119-
the latest known submitted document's `type` for that `id`.
118+
the latest known submitted document's `type` for that `id`.
120119

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

‎docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ timestamp of when the document was created.
8888
#### [`id`](../metadata.md#id) Validation
8989

9090
The document ID validation is performed based on timestamp thresholds:
91-
9291
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9392
current time.
9493
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -110,9 +109,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
110109
1. The document version must always be >= the document ID.
111110
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
112111
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
113-
the latest known submitted version for that `id`.
112+
the latest known submitted version for that `id`.
114113
4. When a document with the same `id` already exists, the new document's `type` must be the same as
115-
the latest known submitted document's `type` for that `id`.
114+
the latest known submitted document's `type` for that `id`.
116115

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

‎docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,6 @@ timestamp of when the document was created.
9292
#### [`id`](../metadata.md#id) Validation
9393

9494
The document ID validation is performed based on timestamp thresholds:
95-
9695
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9796
current time.
9897
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
114113
1. The document version must always be >= the document ID.
115114
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
116115
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
117-
the latest known submitted version for that `id`.
116+
the latest known submitted version for that `id`.
118117
4. When a document with the same `id` already exists, the new document's `type` must be the same as
119-
the latest known submitted document's `type` for that `id`.
118+
the latest known submitted document's `type` for that `id`.
120119

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

‎docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ timestamp of when the document was created.
7878
#### [`id`](../metadata.md#id) Validation
7979

8080
The document ID validation is performed based on timestamp thresholds:
81-
8281
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
8382
current time.
8483
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -100,9 +99,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
10099
1. The document version must always be >= the document ID.
101100
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
102101
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
103-
the latest known submitted version for that `id`.
102+
the latest known submitted version for that `id`.
104103
4. When a document with the same `id` already exists, the new document's `type` must be the same as
105-
the latest known submitted document's `type` for that `id`.
104+
the latest known submitted document's `type` for that `id`.
106105

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

‎docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ timestamp of when the document was created.
8989
#### [`id`](../metadata.md#id) Validation
9090

9191
The document ID validation is performed based on timestamp thresholds:
92-
9392
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
9493
current time.
9594
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -113,9 +112,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
113112
1. The document version must always be >= the document ID.
114113
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
115114
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
116-
the latest known submitted version for that `id`.
115+
the latest known submitted version for that `id`.
117116
4. When a document with the same `id` already exists, the new document's `type` must be the same as
118-
the latest known submitted document's `type` for that `id`.
117+
the latest known submitted document's `type` for that `id`.
119118

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

‎docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,6 @@ timestamp of when the document was created.
111111
#### [`id`](../metadata.md#id) Validation
112112

113113
The document ID validation is performed based on timestamp thresholds:
114-
115114
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
116115
current time.
117116
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -133,9 +132,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
133132
1. The document version must always be >= the document ID.
134133
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
135134
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
136-
the latest known submitted version for that `id`.
135+
the latest known submitted version for that `id`.
137136
4. When a document with the same `id` already exists, the new document's `type` must be the same as
138-
the latest known submitted document's `type` for that `id`.
137+
the latest known submitted document's `type` for that `id`.
139138

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

‎docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@ timestamp of when the document was created.
148148
#### [`id`](../metadata.md#id) Validation
149149

150150
The document ID validation is performed based on timestamp thresholds:
151-
152151
* If `future_threshold` is configured, the document `id` cannot be too far in the future from the
153152
current time.
154153
* If `past_threshold` is configured, the document `id` cannot be too far in the past from the
@@ -170,9 +169,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`]
170169
1. The document version must always be >= the document ID.
171170
2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.
172171
3. When a document with the same `id` already exists, the new document's `ver` must be greater than
173-
the latest known submitted version for that `id`.
172+
the latest known submitted version for that `id`.
174173
4. When a document with the same `id` already exists, the new document's `type` must be the same as
175-
the latest known submitted document's `type` for that `id`.
174+
the latest known submitted document's `type` for that `id`.
176175

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

0 commit comments

Comments
 (0)