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

Jump to bottom

Move "readOnly" from Hyper-Schema to Validation #378

Merged
merged 9 commits into from
Sep 10, 2017
Merged

Move "readOnly" from Hyper-Schema to Validation #378

merged 9 commits into from
Sep 10, 2017

Commits on Sep 8, 2017

  1. Move "readOnly" from Hyper-Schema to Validation 

    We move the description and schema definition of "readOnly" verbatim
from the Hyper-Schema specification (and meta-schema) to the validation
one, in the "Metadata keywords" section (along with "default", in
particular).

This addresses part of json-schema-org#363, which states that some keywords
historically in the Hyper-Schema specification would be better in the
Validation document. The main argument for moving keywords such as
"readOnly" is that the Hyper-Schema document could then only focus on
describing the hypermedia linking model.
    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    6787975 View commit details
    Browse the repository at this point in the history

  2. Fix the "default" value of "readOnly" in its schema definition 

    Change from the "false" string to the `false` Boolean value.
    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    9f2b798 View commit details
    Browse the repository at this point in the history

  3. Only refer to "owning authority" in readOnly description

    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    203cc1c View commit details
    Browse the repository at this point in the history

  4. Use common phrasing for default value of readOnly

    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    605af84 View commit details
    Browse the repository at this point in the history

  5. Move type description of readOnly in its own paragraph 

    As is done for all other keywords.
    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    3af480b View commit details
    Browse the repository at this point in the history

  6. Remove readOnly's description in validation meta-schema 

    The readOnly is property is actually the only one having a description;
it got inherited when moved from hyper-schema meta-schema. So drop it to
be consistent with the rest of the schema.

Additionnally, the current description contains ambiguous "server
language" which we try to avoid.
    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    c8874a7 View commit details
    Browse the repository at this point in the history

  7. Replace "user agent" by "application" in readOnly description 

    The term "user agent" is appropriate in the scope of hypermedia,
not that much elsewhere; "application" is more generic.
    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    b4dc551 View commit details
    Browse the repository at this point in the history

  8. Replace "server-generated" by "database-generated" in readOnly exampl… 

    …e paragraph
    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    1d18f8f View commit details
    Browse the repository at this point in the history

  9. Mention that readOnly can be used for UI generation 

    Echoing the document abstract.
    @dlax
    dlax authored and Denis Laxalde committed Sep 8, 2017
    Configuration menu
    Copy the full SHA
    369648b View commit details
    Browse the repository at this point in the history