Skip to content

Commit 988a72e

Browse files
apasel422clelland
authored andcommitted
Update token references to link to Structured Fields and fix report-to type
- Reference RFC 8941 for Structured Fields rather than legacy draft-14. - Update sh-dictionary and sh-token to sf-dictionary and sf-token. - Update occurrences of token/Token to link to sf-token in RFC 8941. - Specify and parse the report-to directive parameter as a token rather than a string. - Fix typo in Section 6.1.3 example ("endpoiont"). Fixes #47
1 parent 99e9e9f commit 988a72e

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

‎index.bs‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
3434
urlPrefix: browsing-the-web.html
3535
type: dfn
3636
text: process a navigate fetch
37+
spec: RFC8941; urlPrefix: https://datatracker.ietf.org/doc/html/rfc8941#
38+
type: dfn
39+
text: sf-dictionary; url: dictionary
40+
text: sf-token; url: token
3741
</pre>
3842

3943
<section>
@@ -141,7 +145,7 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
141145
configuration points in use attached to this document.
142146

143147
A <a>configuration point</a> has a <dfn
144-
for="configuration point">name</dfn>, which is a token.
148+
for="configuration point">name</dfn>, which is a [=sf-token|token=].
145149

146150
A <a>configuration point</a> has a <dfn
147151
for="configuration point">type</dfn>, which is one of:
@@ -261,7 +265,7 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
261265

262266
If violations for many or all features should be sent to the same endpoint,
263267
then it may be easier to define a single default <a>endpoint</a>. This can
264-
be defined by a parameter on the special token `*`. If a default
268+
be defined by a parameter on the special [=sf-token|token=] `*`. If a default
265269
<a>endpoint</a> is provided, then unless otherwise specified, all violation
266270
reports will be sent to that named endpoint. If a feature also specifies its
267271
own endpoint, with the `report-to` parameter, then reports will go to that
@@ -283,7 +287,7 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
283287
Example:
284288
```
285289
Document-Policy: something=1.0;report-to=none, something-else=?0,
286-
*;report-to=endpoiont
290+
*;report-to=endpoint
287291
```
288292

289293
</section>
@@ -318,27 +322,27 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
318322
## Policies as Structured Headers ## {#policies-as-structured-headers}
319323

320324
Policies are represented in HTTP headers and in HTML attributes as the
321-
serialization of an sh-dictionary structure. Each dictionary member is a
325+
serialization of an <a>sf-dictionary</a> structure. Each dictionary member is a
322326
<a>document policy directive</a>.
323327

324328
A <dfn export>document policy directive</dfn> is an element of a
325329
<a>serialized document policy</a>, and consists of a <a
326-
for="document policy directive">directive name</a>, which is an sh-token,
330+
for="document policy directive">directive name</a>, which is an <a>sf-token</a>,
327331
and associated <a
328332
href="#document-policy-directive-parameters">parameters</a>.
329333

330334
A <dfn for="document policy directive">directive name</dfn> may be one of:
331335

332336
* The <a for="configuration point">name</a> of a <a>configuration point</a>
333-
* The Token "`*`".
337+
* The [=sf-token|Token=] "`*`".
334338

335339
A <dfn export>policy value</dfn> is an element of the <a for="configuration
336340
point">range</a> for the named <a>configuration point</a>.
337341

338342
### Parameters ### {#document-policy-directive-parameters}
339343

340344
Any <a>document policy directive</a> may include a parameter named
341-
`report-to`, whose value must be a string.
345+
`report-to`, whose value must be a [=sf-token|token=].
342346

343347
A <a>document policy directive</a> whose <a for="document policy
344348
directive">directive name</a> names a <a>configuration point</a> with
@@ -358,7 +362,7 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
358362
A <a>document policy directive</a> whose <a for="document policy
359363
directive">directive name</a> names a <a>configuration point</a> with
360364
<a for="configuration point">type</a> `enum` has a required parameter, whose value must be 'true',
361-
and whose name must be a token in the <a>configuration point</a>'s <a
365+
and whose name must be a [=sf-token|token=] in the <a>configuration point</a>'s <a
362366
for="configuration point">range</a>.
363367

364368
Examples:
@@ -382,7 +386,7 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
382386
The <code>Document-Policy</code> header is a Structured Header. Its value
383387
must be a dictionary. Its ABNF is:
384388

385-
Document-Policy = sh-dictionary
389+
Document-Policy = <a>sf-dictionary</a>
386390

387391
If any dictionary member name does not name a supported configuration point
388392
or the special value "*", then the dictionary memver will be ignored by the
@@ -582,7 +586,7 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
582586
1. Let |defaultEndpoint| be a new string, set to null.
583587
1. For each |name|->(|value|,|parameters|) in |header|,
584588
1. Let |currentEndpoint| be a new string, set to null.
585-
1. If |parameters|["report-to"] exists, and is a string, then:
589+
1. If |parameters|["report-to"] exists, and is a [=sf-token|token=], then:
586590
1. Set |currentEndpoint| to the value of |parameters|["report-to"].
587591
1. If |name| is the string "`*`", then:
588592
1. Set |defaultEndpoint| to |currentEndpoint|.
@@ -601,7 +605,7 @@ spec: HTML; urlPrefix: https://html.spec.whatwg.org/multipage/
601605
|currentEndpoint|.
602606
1. Continue with the next |element|.
603607
1. If |configuration point|'s type is enum, then:
604-
1. If |value| is not a Token, then fail.
608+
1. If |value| is not a [=sf-token|Token=], then fail.
605609
1. If |value| is not the name of one of |configuration point|s
606610
allowed enum values, then fail.
607611
1. Set |policy|[|configuration point|] to a new enum <a>policy

0 commit comments

Comments
 (0)