Typos and clarifications to CAEP interop spec#333
Merged
Conversation
- Fix "Sections 8.1.2.1" -> singular "Section" - Replace `AddSubject` with "Add Subject" to match SSF spec - Fix missing articles and prepositions in delivery/subject text - Remove "using ... using" repetition in event signature requirement - "separate entity than" -> "different entity than" - "client credential grant flow" -> "client credentials grant" - Hyphenate "short-lived" and reword exp/nbf claim definition - Remove stray comma before MUST in OAuth scopes bullet - Convert ambiguous MAY in Use Cases intro to MUST support at least one - Replace dangling "These" antecedent in Security Considerations
- Strip redundant [RFCxxxx] prefixes from kramdown-rfc references
(renders duplicated text otherwise)
- Rename "Get Stream Status" labels to "Read Stream Status" to match
the operation name used in the body and in SSF Section 8.1.2.1
- Title Case headings consistently ("Network Layer Protection",
"CAEP Specification Version")
- Capitalize "SSF Receiver" consistently
- Refer to `device-compliance-change` as a CAEP event type consistently
- "### Spec Version" -> "### Specification Version"
- Backtick `status_endpoint` to match formatting elsewhere
- Add missing colon before sub-list of OAuth grant types
- Reword "in the query parameters stated in" to "via the URI query
parameter mechanism described in" (RFC 6750 terminology)
- Capitalize "Resource Server" and "Section 3.1/4.1/4.4"
- Drop stray trailing period from one Resource Server bullet
- "use-cases" -> "use cases"
- "POLL delivery" -> "Poll delivery" in reference comment
jischr
approved these changes
May 15, 2026
tulshi
approved these changes
May 19, 2026
appsdesh
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Define short-lived access tokens format-neutrally (there's not a requirement I'm aware of for JWT access tokens to be used when you're doing SSF/CAEP)
Fix reason_admin - it was referred to as a string, but it's defined as an object
Fix inconsistencies
(renders duplicated text otherwise)
the operation name used in the body and in SSF Section 8.1.2.1
"CAEP Specification Version")
device-compliance-changeas a CAEP event type consistentlystatus_endpointto match formatting elsewhereparameter mechanism described in" (RFC 6750 terminology)
Grammar and typo fixes
I think the only potentially contentious change is replacing:
with:
However I believe the intent remains unchanged, the language is just clearer now.