3.2: update normative reference for JSON to RFC8259 #4499
Merged
Conversation
This file contains 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
ralfhandl
changed the title
ralfhandl
commented
Mar 26, 2025
| @@ -117,7 +117,7 @@ Occasionally, non-backwards compatible changes may be made in `minor` versions o | |||
|
|
|||
| ### Format | |||
|
|
|||
| An OpenAPI Document that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in JSON or YAML format. | |||
| An OpenAPI Document that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in [[RFC8259|JSON]] or [[YAML|YAML]] format. | |||
There was a problem hiding this comment.
Make reference to JSON RFC explicit.
Otherwise our HTML build script would reference the old RFC in
ralfhandl
commented
Mar 26, 2025
| @@ -2556,13 +2556,13 @@ The runtime expression is defined by the following [ABNF](https://tools.ietf.org | |||
| ; %x2F ('/') and %x7E ('~') are excluded from 'unescaped' | |||
| escaped = "~" ( "0" / "1" ) | |||
| ; representing '~' and '/', respectively | |||
| name = *( CHAR ) | |||
| name = *char | |||
There was a problem hiding this comment.
Note: RFC7159 and RFC8259 both name this rule char. ABNF rule names are case-insensitive, but it is still easier to check the reference if the casing is exactly the same.
ralfhandl
commented
Mar 26, 2025
| token = 1*tchar | ||
| tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." | ||
| / "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA | ||
| ``` | ||
|
|
||
| Here, `json-pointer` is taken from [RFC6901](https://tools.ietf.org/html/rfc6901), `CHAR` from [RFC7159](https://tools.ietf.org/html/rfc7159#section-7) and `token` from [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.2). | ||
| Here, `json-pointer` is taken from [RFC6901](https://tools.ietf.org/html/rfc6901), `char` from [RFC8259](https://tools.ietf.org/html/rfc8259#section-7) and `token` from [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.6.2). |
There was a problem hiding this comment.
Use RFC8259 rule name casing.
handrews
approved these changes
Mar 26, 2025
lornajane
approved these changes
Mar 27, 2025
miqui
approved these changes
Mar 27, 2025
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.
Fixes #4487
Non-obvious changes are commented.
Tick one of the following options: