Skip to content

Commit af47cc6

Browse files
committed
Add "description" as an LDO keyword.
This addresses issue #325. It adds the description keyword, analogous to "description" in validation schemas. In RFC 5988bis parlance, "description" is an extension target attribute.
1 parent 737e718 commit af47cc6

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

jsonschema-hyperschema.xml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -877,14 +877,29 @@ GET /foo/
877877
<section title="title">
878878
<t>
879879
This property defines a title for the link.
880-
The value must be a string.
880+
The value MUST be a string.
881881
</t>
882882

883883
<t>
884884
User agents MAY use this title when presenting the link to the user.
885885
</t>
886886
</section>
887887

888+
<section title="description">
889+
<t>
890+
This property provides additional information beyond what
891+
is present in the title. The value MUST be a string.
892+
While a title is preferably short, a description can be
893+
used to go into more detail about the purpose and usage
894+
of the link.
895+
</t>
896+
897+
<t>
898+
User agents MAY use this description when presenting
899+
the link to the user.
900+
</t>
901+
</section>
902+
888903
<section title="targetSchema" anchor="targetSchema">
889904
<t>
890905
This property provides a schema that is expected to describe

0 commit comments

Comments
 (0)