Update render JSON spec for variantOverrides #20
Merged
Conversation
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
Update the render JSON spec for the changes introduced in swiftlang#11. SR-15354 rdar://83667105
franklinsch
force-pushed
the
r82919099-variantoverrides-spec
branch
from
e5ac6e8 to
6c50150
Compare
mportiz08
reviewed
Oct 29, 2021
Contributor
mportiz08
left a comment
mportiz08
left a comment
There was a problem hiding this comment.
Looks good overall.
I have one suggestion for improving the JSON Patch details.
| "JSONPatch": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", |
Contributor
There was a problem hiding this comment.
One possible improvement might be to create explicit types for each distinct operation kind so that we can more clearly define which ones take which arguments (as opposed to just using the enum for the op field).
While each operation technically requires a path argument, some of them require a value and others require a from (etc). It is unlikely to occur in practice, but this spec could technically validate some invalid structures like
{
"op": "test",
"path": "/a/b/c",
"from": "foo"
}
Contributor
Author
There was a problem hiding this comment.
Great idea! I updated the spec with oneOf values.
Use oneOf to specify what properties are expected for each JSON patch operation. rdar://82919099
mportiz08
approved these changes
Nov 1, 2021
Contributor
Author
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Bug/issue #, if applicable: rdar://83667105, SR-15354
Summary
Update the render JSON spec for the changes introduced in #11.
Dependencies
None.
Testing
There should be no user-facing changes. Verify that the specification matches the JSON produced by Swift-DocC.
Checklist
[ ] Added testsN/A./bin/testscript and it succeeded