Skip to content
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

Clarify optional attributes #165

Merged
merged 6 commits into from
Sep 7, 2021
Merged

Clarify optional attributes #165

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
11f57c8
Clarify that delegations are optional
MVrachev Apr 21, 2021
2a8d459
Make CONSISTENT_SNAPSHOT optional
MVrachev May 31, 2021
4dd279b
Clarify "paths" and "path_hash_prefixes"
MVrachev May 31, 2021
caa3ed8
Merge branch 'master' into clarify-optional
joshuagl Sep 7, 2021
c06a5b8
Update tuf-spec.md
joshuagl Sep 7, 2021
4d7f979
Merge branch 'master' into clarify-optional
mnm678 Sep 7, 2021
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
18 changes: 10 additions & 8 deletions tuf-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Boilerplate: copyright no, conformance no
Local Boilerplate: header yes
Markup Shorthands: css no, markdown yes
Metadata Include: This version off, Abstract off
Text Macro: VERSION 1.0.23
Text Macro: VERSION 1.0.24
</pre>

Note: We strive to make the specification easy to implement, so if you come
Expand Down Expand Up @@ -692,9 +692,11 @@ The "signed" portion of <a>root.json</a> is as follows:

: <dfn>CONSISTENT_SNAPSHOT</dfn>
::
A boolean indicating whether the repository supports
consistent snapshots. Section [[#consistent-snapshots]] goes into more
detail on the consequences of enabling this setting on a repository.
An OPTIONAL boolean indicating whether the repository supports
consistent snapshots. This field is OPTIONAL for backwards compatibility with
old metadata. New implementations SHOULD include it. Section
[[#consistent-snapshots]] goes into more detail on the consequences of
enabling this setting on a repository.

: <dfn for="role">VERSION</dfn>
::
Expand Down Expand Up @@ -980,7 +982,8 @@ as is described for the <a>root.json</a> file.
<a>TARGETPATH</a>. The application may use this information to guide
download decisions.

<dfn>DELEGATIONS</dfn> is an object whose format is the following:
<dfn>DELEGATIONS</dfn> is an OPTIONAL object and if defined it has the following
format:

<pre highlight="json">
{
Expand Down Expand Up @@ -1024,9 +1027,8 @@ as is described for the <a>root.json</a> file.
package that are not made by the delegated party or its descendants to be
ignored.

In order to discuss target paths, a role MUST specify only one of the
<a>"path_hash_prefixes"</a> or <a for="delegation-role">"paths"</a> attributes,
each of which we discuss next.
The <a>"path_hash_prefixes"</a> and <a for="delegation-role">"paths"</a>
attributes are OPTIONAL, if used, exactly one of them should be set.

: <dfn>"path_hash_prefixes"</dfn>
::
Expand Down