Skip to content

Commit 60d1551

Browse files
authored
Fix bikeshed errors and use "Structured Fields" consistently. (#252)
* Fixes structured {headers -> fields} * Updates HTTP RFC reference * Replace "context object" with "this" where appropriate
1 parent fa09b26 commit 60d1551

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

index.src.html

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h1>Reporting API</h1>
113113
text: session; url: dfn-session
114114
text: success; url: dfn-success
115115
text: trying; url: dfn-try
116-
spec: STRUCTURED-HEADERS; urlPrefix: https://www.rfc-editor.org/rfc/rfc8941.html#
116+
spec: STRUCTURED-FIELDS; urlPrefix: https://www.rfc-editor.org/rfc/rfc8941.html#
117117
type: grammar
118118
text: sf-dictionary; url: section-3.2
119119
</pre>
@@ -125,7 +125,7 @@ <h1>Reporting API</h1>
125125
"title": "Secure Contexts",
126126
"publisher": "W3C"
127127
},
128-
"STRUCTURED-HEADERS": {
128+
"STRUCTURED-FIELDS": {
129129
"authors": [ "Mark Nottingham", "Poul-Henning Kamp" ],
130130
"href": "https://www.rfc-editor.org/rfc/rfc8941.html",
131131
"title": "Structured Field Values for HTTP",
@@ -420,8 +420,8 @@ <h3 id="header">The `Reporting-Endpoints` HTTP Response Header Field</h3>
420420
The value of the <dfn export>`Reporting-Endpoints`</dfn> HTTP response header
421421
field is used to construct the reporting configuration for a resource.
422422

423-
<a>`Reporting-Endpoints`</a> is a Dictionary Structured Header
424-
[[STRUCTURED-HEADERS]]. Each entry in the dictionary defines an
423+
<a>`Reporting-Endpoints`</a> is a Dictionary Structured Field
424+
[[STRUCTURED-FIELDS]]. Each entry in the dictionary defines an
425425
<a>endpoint</a> to which reports may be delivered. The entry value MUST be a
426426
string.
427427

@@ -438,7 +438,7 @@ <h3 id="header">The `Reporting-Endpoints` HTTP Response Header Field</h3>
438438
The header is represented by the following ABNF grammar [[!RFC5234]]:
439439

440440
<pre class="abnf" link-type="grammar" dfn-type="grammar">
441-
Reporting-Endpoints = <a>sh-dictionary</a>
441+
Reporting-Endpoints = <a>sf-dictionary</a>
442442
</pre>
443443

444444
<h3 id="process-header" algorithm>
@@ -640,7 +640,7 @@ <h4 id="try-delivery" algorithm>
640640
6. If |response|'s `status` is an <a>OK status</a> (200-299), return
641641
"`Success`".
642642

643-
7. If |response|'s `status` is `410 Gone` [[!RFC7231]], return "`Remove
643+
7. If |response|'s `status` is `410 Gone` [[!RFC9110]], return "`Remove
644644
Endpoint`".
645645

646646
8. Return "`Failure`".
@@ -741,36 +741,34 @@ <h3 id=interface-reporting-observer>Interface {{ReportingObserver}}</h3>
741741
The <dfn method for=ReportingObserver><code>observe()</code></dfn>
742742
method, when invoked, must run these steps:
743743

744-
1. Let |global| be the be the [=relevant global object=] of the <a>context
745-
object</a>.
744+
1. Let |global| be the be the [=relevant global object=] of <a>this</a>.
746745

747-
2. Append the <a>context object</a> to the |global|'s <a>registered reporting
746+
2. Append <a>this</a> to the |global|'s <a>registered reporting
748747
observer list</a>.
749748

750-
3. If the <a>context object</a>'s {{buffered}} <a>option</a> is false, return.
749+
3. If <a>this</a>'s {{buffered}} <a>option</a> is false, return.
751750

752-
4. Set <a>context object</a>'s {{buffered}} <a>option</a> to false.
751+
4. Set <a>this</a>'s {{buffered}} <a>option</a> to false.
753752

754753
5. For each |report| in |global|'s <a>report buffer</a>, <a>queue a task</a>
755-
to execute [[#add-report]] with |report| and the <a>context object</a>.
754+
to execute [[#add-report]] with |report| and <a>this</a>.
756755

757756
The <dfn method for=ReportingObserver><code>disconnect()</code></dfn> method,
758757
when invoked, must run these steps:
759758

760-
1. If the <a>context object</a> is not <a>registered</a>, return.
759+
1. If <a>this</a> is not <a>registered</a>, return.
761760

762-
2. Let |global| be the [=relevant global object=] of the <a>context
763-
object</a>.
761+
2. Let |global| be the [=relevant global object=] of <a>this</a>.
764762

765-
3. Remove the <a>context object</a> from |global|'s <a>registered reporting
763+
3. Remove <a>this</a> from |global|'s <a>registered reporting
766764
observer list</a>.
767765

768766
The <dfn method for=ReportingObserver><code>takeRecords()</code></dfn> method,
769767
when invoked, must run these steps:
770768

771-
1. Let |reports| be a copy of the <a>context object</a>'s <a>report queue</a>.
769+
1. Let |reports| be a copy of <a>this</a>'s <a>report queue</a>.
772770

773-
2. Empty the <a>context object</a>'s <a>report queue</a>.
771+
2. Empty <a>this</a>'s <a>report queue</a>.
774772

775773
3. Return |reports|.
776774

0 commit comments

Comments
 (0)