Skip to content

Clarify options for resolving template variables #291

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Clarify options for resolving template variables #291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions jsonschema-hyperschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,15 @@
unresolved MUST be resolved from the resource instance data.
</t>

<t>
If a URI Template variable corresponds to both an instance value
and a schema for external data, an application MAY choose to
present the instance value to the user as a default value.
This will ensure that, if the user takes no action to change
the value, the effect of resolving from the client or instace
data will be the same.
</t>

<section title="Converting to strings">
<t>
When any value referenced by the URI template is null, a boolean or a number, then it should first be converted into a string as follows:
Expand Down Expand Up @@ -576,6 +585,12 @@
}]
}]]>
</artwork>
<postamble>
Note that this example is identical to a server pre-computing
the path component of the URI (with "{id}") while the query
string component is handled by client input as with an HTML
"method"="get" form.
</postamble>
</figure>
<t>
<cref>
Expand Down