-
-
Notifications
You must be signed in to change notification settings - Fork 314
Rewrite the Hyper-Schema spec almost entirely #427
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
Merged
Merged
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
6f3d93b
"base" is a URI Template
handrews e24b382
Rewrite hyper-schema almost entirely
handrews 04715a1
Add more English descriptions
handrews 756afe3
Use numbered lists for steps
handrews 1f7fd39
Default "submissionSchema" to true
handrews db7fe7c
Introduce the LDO in the introduction
handrews 8e7b8da
Condense server-side usage overview
handrews 69f3e3b
Keep specific keywords out of general concerns
handrews e92b417
Exclude LDO schema keywords from applicability
handrews 7d64e91
Wording improvements from PR review
handrews c5cc781
Remove commented text, simplify Accept-Post
handrews 0dbd8a8
Fix more typos, better variable name.
handrews 175852e
Keep initial functionality description high-level
handrews 95aed67
Rework implementation requirements from move
handrews 04178da
Trim down JSON Hyper-Schemas in APIs appendix
handrews 315a493
Next hyper-schema draft will be handrews-00
handrews 5872491
Add output format schema, tidy up other schemas
handrews 632a8e1
Numerous spelling fixes
handrews 9834381
Move HTTP up between Implementation and Examples
handrews 365ef27
Wording improvements around HTTP usage.
handrews 2706f3e
Forgot to change appendix to section
handrews ef4b0f0
Forgot to finish sentence
handrews 9bfcc50
Update core change log, rename drafts
handrews File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
{ | ||
"$id": "http://json-schema.org/draft-7-wip/hyper-schema-output", | ||
"$schema": "http://json-schema.org/draft-07-wip/schema#", | ||
"type": "array", | ||
"items": { | ||
"allOf": [ | ||
{"$ref": "http://json-schema.org/draft-07/links#/definitions/noRequiredFields" } | ||
], | ||
"type": "object", | ||
"required": [ | ||
"contextUri", | ||
"contextPointer", | ||
"rel", | ||
"attachmentPointer" | ||
], | ||
"if": { "required": [ "hrefSchema" ] }, | ||
"then": { "required": [ "hrefInputTemplates", "hrefPrepopulatedInput" ] }, | ||
"else": { "required": [ "targetUri" ] }, | ||
"properties": { | ||
"contextUri": { | ||
"$comment": "The fully resolved URI of the link context, including a fragment if it is possible to construct one for the given media type and instance", | ||
"type": "string", | ||
"format": "uri" | ||
}, | ||
"contextPointer": { | ||
"$comment": "The absolute JSON Pointer to the location in the instance that is the context of the link. If the context resource supports JSON Pointer fragments, this will the string form of the identical JSON Pointer", | ||
"type": "string", | ||
"format": "json-pointer" | ||
}, | ||
"rel": { | ||
"type": "string" | ||
}, | ||
"targetUri": { | ||
"$comment": "The fully resolved target URI", | ||
"type": "string", | ||
"format": "uri" | ||
}, | ||
"hrefInputTemplates": { | ||
"$comment": "The list of partially resolved URI Templates, starting with \"href\", followed by applicable \"base\" values from nearest to furthest.", | ||
"type": "array", | ||
"items": { | ||
"type": "string", | ||
"format": "uri-template" | ||
} | ||
}, | ||
"hrefPrepopulatedInput": { | ||
"$comment": "The initial data set to be presented with the input form when URI Tempalte input is accepted.", | ||
"type": "object", | ||
"propertyNames": { | ||
"$comment": "These are all URI Template variable names, specifically the 'varname' production from RFC 6570, Section 2.3", | ||
"pattern": "^(?:\\w|(?:%[a-f\\d]{2}))+(?:\\.(?:\\w|(?:%[a-f\\d]{2})))*$" | ||
} | ||
}, | ||
"attachmentPointer": { | ||
"$comment": "The absolute JSON Pointer, in string form, of the position to which this resolved link applies", | ||
"type": "string", | ||
"format": "json-pointer" | ||
} | ||
} | ||
} | ||
} |
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
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
Oops, something went wrong.
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.
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.
typo: Tempalte