Skip to content

Commit 07a3562

Browse files
authored
Merge pull request #353 from handrews/description
Add "description" as an LDO keyword.
2 parents e088bff + e107322 commit 07a3562

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

hyper-schema.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@
3838
"description": "a title for the link",
3939
"type": "string"
4040
},
41+
"description": {
42+
"description": "additional information about the purpose or usage of the link",
43+
"type": "string"
44+
},
4145
"targetSchema": {
4246
"description": "JSON Schema describing the link target",
4347
"allOf": [ { "$ref": "#" } ]

jsonschema-hyperschema.xml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -909,14 +909,29 @@ GET /foo/
909909
<section title="title">
910910
<t>
911911
This property defines a title for the link.
912-
The value must be a string.
912+
The value MUST be a string.
913913
</t>
914914

915915
<t>
916916
User agents MAY use this title when presenting the link to the user.
917917
</t>
918918
</section>
919919

920+
<section title="description">
921+
<t>
922+
This property provides additional information beyond what
923+
is present in the title. The value MUST be a string.
924+
While a title is preferably short, a description can be
925+
used to go into more detail about the purpose and usage
926+
of the link.
927+
</t>
928+
929+
<t>
930+
User agents MAY use this description when presenting
931+
the link to the user.
932+
</t>
933+
</section>
934+
920935
<section title="targetSchema" anchor="targetSchema">
921936
<t>
922937
This property provides a schema that is expected to describe

0 commit comments

Comments
 (0)