Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Update document to Draft 6 #74

Merged
merged 23 commits into from
Sep 20, 2018
Merged

Update document to Draft 6 #74

merged 23 commits into from
Sep 20, 2018

Conversation

mdboom
Copy link
Member

@mdboom mdboom commented Aug 7, 2018

This is a work-in-progress branch updating the document to refer to Draft 6.

Ideally, draft 7 will come shortly after Julian/jsonschema supports it, so the examples can continue to be automatically verified.

@mdboom mdboom requested review from Relequestual and handrews August 7, 2018 18:31
@mdboom mdboom changed the title WIP: Update document to Draft 6 Update document to Draft 6 Aug 7, 2018
@embray
Copy link
Collaborator

embray commented Aug 10, 2018

Cool! 👍

Copy link
Member

@Relequestual Relequestual left a comment

Choose a reason for hiding this comment

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

Great work! A few minor changes and one or two questions, but otherwise this is great. Thanks for your hard work.

some schema as well. This is done using the ``items`` and
``additionalItems`` keywords.
some schema as well. This is done using the ``items``,
``additionalItems`` and ``contains`` keywords.
Copy link
Member

Choose a reason for hiding this comment

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

Oxford comma please.

Hey, at least I'm reviewing it!

JSON Schema includes a few keywords, ``title``, ``description`` and
``default``, that aren't strictly used for validation, but are used to
describe parts of a schema.
JSON Schema includes a few keywords, ``title``, ``description``, ``default`` and
Copy link
Member

Choose a reason for hiding this comment

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

Oxford comma

@@ -149,46 +149,78 @@ Range
'''''

Ranges of numbers are specified using a combination of the
``minimum``, ``maximum``, ``exclusiveMinimum`` and
``exclusiveMaximum`` keywords.
``minimum`` and ``maximum`` keywords (or ``exclusiveMinimum`` and
Copy link
Member

Choose a reason for hiding this comment

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

comma


JSON Schema hyperschema written against the current version of the
specification.
version of the JSON Schema standard, you can include the draft name in the path, for example:
Copy link
Member

Choose a reason for hiding this comment

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

/can/should/

@@ -139,46 +141,190 @@ schema for a customer:
}
}

.. note::

Even though the value of a ``$ref`` is a URI, it is not a network locator,
Copy link
Member

Choose a reason for hiding this comment

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

It does not need to be network accessible, but it also may be.

}

However, a loop of ``$ref`` schemas referring to one another could cause
infinite recursion in the validator, and is explicitly disallowed.
Copy link
Member

Choose a reason for hiding this comment

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

Is it worth expanding this to explain that loops are allowed, but this example shows an unresolveable $ref resolution loop, not a validation loop?

@mdboom
Copy link
Member Author

mdboom commented Aug 20, 2018

Thanks. I've updated based on your feedback. (I'm an Oxford comma fan, but U.S. grad school beat it out of me, so I've ended up rather inconsistent.)

@mdboom
Copy link
Member Author

mdboom commented Aug 28, 2018

@Relequestual : Do changes address your concerns?

@handrews
Copy link

@mdboom @Relequestual might be a bit delayed in responding right now, I'll message you on slack with more info

@mdboom
Copy link
Member Author

mdboom commented Sep 20, 2018

I'm going to merge this to move forward, since I think it's mostly correct. File issues and PRs for things that aren't!

@mdboom mdboom merged commit 02c79aa into json-schema-org:master Sep 20, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants