Skip to content

Commit 3b18e00

Browse files
authored
Fix Indefinite Articles Before "SSF" (#145)
The spec contains multiple instances of phrases like "a SSF Event", "a SSF receiver", etc. These should be "an SSF ..." - other places in the specs already use the correct form. See also, e.g., https://www.merriam-webster.com/grammar/is-it-a-or-an and https://blog.apastyle.org/apastyle/2012/04/using-a-or-an-with-acronyms-and-abbreviations.html
1 parent 7b00ef9 commit 3b18e00

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

openid-sharedsignals-framework-1_0.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ This Shared Signals Framework specification defines a Subject Principal to be
238238
the entities about which an event can be sent by Transmitters and received by
239239
Receivers using the Shared Signals Framework.
240240

241-
Subject Principals are the managed entities in a SSF Transmitter or Receiver.
241+
Subject Principals are the managed entities in an SSF Transmitter or Receiver.
242242
These include human or robotic principals, devices, customer tenants in a
243243
multi-tenanted service, organizational units within a tenant, groups of subject
244244
principals, or other entities that are managed by Transmitters and Receivers.
@@ -251,7 +251,7 @@ Subject Principals are identified by Subject Members defined below.
251251
# Subject Members in SSF Events {#subject-ids}
252252

253253
## Subject Members {#subject-members}
254-
A Subject Member of a SSF event describes a subject of the event. A top-level claim named `sub_id` MUST be used to describe the primary subject of the event.
254+
A Subject Member of an SSF event describes a subject of the event. A top-level claim named `sub_id` MUST be used to describe the primary subject of the event.
255255

256256
### Existing CAEP and RISC Events
257257
Event types already defined in the CAEP ({{CAEP}}) and RISC ({{RISC}}) specifications MAY use a `subject` field within the `events` claim of the SSF event to describe the primary Subject Principal of the event. SSF Transmitters MUST include the top-level `sub_id` claim even for these existing event types.
@@ -269,7 +269,7 @@ Each Subject Member MUST refer to exactly one Subject Principal. The value of a
269269

270270
A Simple Subject Member has a claim name and a value that is a "Subject
271271
Identifier" as defined in the Subject Identifiers for Security Event Tokens
272-
{{SUBIDS}}. Below is a non-normative example of a Simple Subject Member in a SSF
272+
{{SUBIDS}}. Below is a non-normative example of a Simple Subject Member in an SSF
273273
event.
274274

275275
~~~ json
@@ -318,7 +318,7 @@ group
318318
Additional Subject Member names MAY be used in Complex Subjects. Each member name MAY
319319
appear at most once in the Complex Subject value.
320320

321-
Below is a non-normative example of a Complex Subject claim in a SSF event.
321+
Below is a non-normative example of a Complex Subject claim in an SSF event.
322322

323323
~~~ json
324324
"sub_id": {
@@ -344,7 +344,7 @@ Subject Principal.
344344

345345
## Subject Identifiers in SSF Events {#subject-ids-in-ssf}
346346

347-
A Subject Identifier in a SSF event MUST have an identifier format that is any
347+
A Subject Identifier in an SSF event MUST have an identifier format that is any
348348
one of:
349349

350350
* Defined in the IANA Registry defined in Subject Identifiers for Security
@@ -463,7 +463,7 @@ The following are hypothetical examples of SETs that conform to the Shared Signa
463463
}
464464
}
465465
~~~
466-
{: #subject-ids-ex-simple title="Example: SET Containing a SSF Event with a Simple Subject Member"}
466+
{: #subject-ids-ex-simple title="Example: SET Containing an SSF Event with a Simple Subject Member"}
467467

468468
~~~ json
469469
{
@@ -507,7 +507,7 @@ The following are hypothetical examples of SETs that conform to the Shared Signa
507507
}
508508
}
509509
~~~
510-
{: #subject-ids-ex-complex title="Example: SET Containing a SSF Event with a Complex Subject Member"}
510+
{: #subject-ids-ex-complex title="Example: SET Containing an SSF Event with a Complex Subject Member"}
511511

512512
~~~ json
513513
{
@@ -533,7 +533,7 @@ The following are hypothetical examples of SETs that conform to the Shared Signa
533533
}
534534
}
535535
~~~
536-
{: #subject-properties-ex title="Example: SET Containing a SSF Event with a Simple Subject and a Property Member"}
536+
{: #subject-properties-ex title="Example: SET Containing an SSF Event with a Simple Subject and a Property Member"}
537537

538538
~~~ json
539539
{
@@ -559,7 +559,7 @@ The following are hypothetical examples of SETs that conform to the Shared Signa
559559
}
560560
}
561561
~~~
562-
{: #subject-custom-type-ex title="Example: SET Containing a SSF Event with a Proprietary Subject Identifier Format"}
562+
{: #subject-custom-type-ex title="Example: SET Containing an SSF Event with a Proprietary Subject Identifier Format"}
563563

564564
# Transmitter Configuration Discovery {#discovery}
565565

@@ -1819,7 +1819,7 @@ A Transmitter MAY respond to verification event requests even if the event is no
18191819

18201820

18211821
#### Verification Event {#verification-event}
1822-
The Verification Event is a SSF Event with the event type: "https://schemas.openid.net/secevent/ssf/event-type/verification". The event contains the following attribute:
1822+
The Verification Event is an SSF Event with the event type: "https://schemas.openid.net/secevent/ssf/event-type/verification". The event contains the following attribute:
18231823

18241824
state
18251825

@@ -2096,7 +2096,7 @@ The signature key can be obtained through "jwks_uri", see {{discovery}}.
20962096

20972097
### SSF Event Subject {#event-subjects}
20982098
The primary Subject Member of SSF events is described in the "Subject Members" section ({{subject-ids}}). The JWT "sub" claim MUST NOT be present in any SET containing
2099-
a SSF event.
2099+
an SSF event.
21002100

21012101
### SSF Event Properties {#event-properties}
21022102
The SSF event MAY contain additional claims within the event payload that are

0 commit comments

Comments
 (0)