Skip to content
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

Fix #74: add "deprecated" keyword #737

Merged
merged 3 commits into from
May 19, 2019
Merged

Fix #74: add "deprecated" keyword #737

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af6231d
Fix #74: add "deprecated" keyword
handrews May 10, 2019
b0d1437
Similar wording to OpenAPI
May 16, 2019
a51ff12
Feedback from @handrews
May 17, 2019
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
27 changes: 24 additions & 3 deletions jsonschema-validation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<email>[email protected]</email>
</address>
</author>

<author fullname="Ben Hutton" initials="B" surname="Hutton" role="editor">
<organization>Wellcome Sanger Institute</organization>
<address>
Expand Down Expand Up @@ -956,7 +956,7 @@
"const": {
"typ": "JWT",
"alg": "HS256"
}
}
},
{
"type": "object",
Expand All @@ -967,7 +967,7 @@
}
}
]
}
}
}]]>
</artwork>
<postamble>
Expand Down Expand Up @@ -1028,6 +1028,27 @@
</t>
</section>

<section title='"deprecated"'>
<t>
The value of this keyword MUST be a boolean. When multiple occurrences
of this keyword are applicable to a single sub-instance, the resulting
value MUST be true if any occurrence specifies a true value, and MUST
be false otherwise.
</t>
<t>
If "deprecated" has a value of boolean true, it indicates that applications
SHOULD refrain from usage of the declared operation. It MAY mean the property
is going to be removed in the futuree.
</t>
<t>
An instance document that is marked as "deprecated" for the entire document
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add something about how this is done by setting "deprecated": true in the root schema. Just reading through this without thinking of the history, it sounds a bit like marking an instance document as deprecated is a rather separate thing.

means the entire document MAY be removed in the future.
</t>
<t>
Omitting this keyword has the same behavior as a value of false.
</t>
</section>

<section title='"readOnly" and "writeOnly"'>
<t>
The value of these keywords MUST be a boolean. When multiple occurrences
Expand Down
4 changes: 4 additions & 0 deletions meta/meta-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
"type": "string"
},
"default": true,
"deprecated": {
"type": "boolean",
"default": false
},
"readOnly": {
"type": "boolean",
"default": false
Expand Down