-
Notifications
You must be signed in to change notification settings - Fork 2
Editorial pass #10
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.
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
Editorial pass #10
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR performs an editorial pass on the OpenID Federation Extended Listing specification for improved clarity and consistency. Key changes include cleanup of document indentation and formatting; removal of the revoked parameter reference; and updates to example values and parameter descriptions (e.g. changing "entity_statement" to "subordinate_statement").
Comments suppressed due to low confidence (2)
openid-federation-extended-listing-1_0.md:148
- There is a redundant article in the caption ('the those'). Consider removing 'the' to read 'those specified by the federation_list_endpoint' for clarity.
*Table 1: Additional request parameters accepted by the Federation Extended Subordinate Listing endpoint in addition to the those specified by the `federation_list_endpoint`*
openid-federation-extended-listing-1_0.md:320
- Replace the contraction 'it's' with the possessive 'its' in the phrase 'according to its defined upper limit'.
This request specified no `limit` however the Issuing Entity chose to limit the response size according to it's defined upper limit.
peppelinux
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved along with my suggestions
I'd leave the decision to use error code or value to you, while other small editorials are included in my review.
Co-authored-by: Giuseppe De Marco <demarcog83@gmail.com>
Co-authored-by: Giuseppe De Marco <demarcog83@gmail.com>
Co-authored-by: Giuseppe De Marco <demarcog83@gmail.com>
Co-authored-by: Giuseppe De Marco <demarcog83@gmail.com>
Co-authored-by: Giuseppe De Marco <demarcog83@gmail.com>
selfissued
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved with suggested changes. Also, change please change the copyright year to 2025.
| | **Claim** | **Availability** | **Type** | **Value** | | ||
| |--------------------------------|------------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | immediate_subordinate_entities | REQUIRED | Array | Array of JSON objects, each describing an Immediate Subordinate Entity using the structure defined in the table below | | ||
| | immediate_subordinate_entities | REQUIRED | Array | Array of JSON objects, each describing an Immediate Subordinate Entity using the structure defined in the table below | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| | immediate_subordinate_entities | REQUIRED | Array | Array of JSON objects, each describing an Immediate Subordinate Entity using the structure defined in the table below | | |
| | immediate_subordinate_entities | REQUIRED | Array | Array of JSON objects, each describing an Immediate Subordinate Entity using the structure defined in the table below. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally, we don't include a period at the end of table entries - particularly when the text is not a sentence.
revokedparameter as I feel this is best defined in implementation extensions if required. Not convinced it fits so well with a "standard" OpenID Federation deployment