fge / sample-json-schemas Goto Github PK

View Code? Open in Web Editor NEW

104.0 17.0 43.0 426 KB

Sample JSON Schemas

sample-json-schemas's Introduction

What this repository is

This repository contains sample JSON Schemas for various JSON-based formats found around the web.

There are many such formats, and this repository contains schemas for whatever formats I happened to stumble upon.

Existing schemas in this repository

This repository contains schemas for the following:

JSON-RPC 2.0 (link to specification);
GeoJSON (link to specification);
SMD (link to specification);
JSON Patch (link to specification);
Avro Schema 1.7.4 (link to specification);
JSON Home (link to specification);
JSON Stat (link to specification).
Swagger 1.2 (link to specification).

Note: these schemas are probably not perfect. See below.

How these schemas are written and tested

I use my toy site to check both the validity of the schema syntax, and the validation of data against these schemas.

This site uses my library, which I am fully confident about. But I am not that confident about the schemas themselves.

I have read the relevant specifications, but I certainly have missed some points in them, and as a result these schemas may not be accurate. Not to mention that some constraints expressed by these specifications are not enforceable by JSON Schema.

Requests and contributions

Both are welcome:

if you stumble upon a JSON data format which you would like a JSON Schema for, feel free to open a feature request so that a schema be written for that format;
if you spot an error on a schema (data which should validate but does not, or the opposite), you can provide sample data and the expected and actual results, using the site above; or you can submit a pull request to improve the schema itself;
if, on the other hand, you have written a schema for an existing format, and wish to add it to this repository, you are welcome to open a pull request so that this schema be included in the examples. Provided that you are ready to comply to the...

Licensing conditions

The licensing conditions are the same as they are for JSON Schema itself: content in this repository may be licensed under either of the AFL or BSD license.

sample-json-schemas's People

Contributors

Stargazers

Watchers

sample-json-schemas's Issues

questionable schema

Maybe my parser is not correct, but to get my code to parse some of the schema I had to make a few changes, shown below. I honestly did not try to understand the details of these schema, but was just trying to grab some valid schema on the net to pass through a visualizer I'm working on. These schema and a couple more can be viewed at: https://github.com/patefacio/json_schema/tree/master/dot_samples/schemaout

Hopefully these changes are helpful, but I'm not sure.

diff dot_samples/original/avro-schema.json dot_samples/schemas/avro-schema.json 
32,33c32,33
<                 "name": { "$ref": "#/definitions/nameOrNamespace" },
<                 "nameOrNamespace": { "$ref": "#/definitions/namespace" },

---
>                 "name": { "$ref": "#/definitions/name" },
>                 "nameOrNamespace": { "$ref": "#/definitions/nameOrNamespace" },
48,49c48,49
<                 "name": { "$ref": "#/definitions/nameOrNamespace" },
<                 "nameOrNamespace": { "$ref": "#/definitions/namespace" },

---
>                 "name": { "$ref": "#/definitions/name" },
>                 "nameOrNamespace": { "$ref": "#/definitions/nameOrNamespace" },
101,102c101,102
<                 "name": { "$ref": "#/definitions/nameOrNamespace" },
<                 "nameOrNamespace": { "$ref": "#/definitions/namespace" },

---
>                 "name": { "$ref": "#/definitions/name" },
>                 "nameOrNamespace": { "$ref": "#/definitions/nameOrNamespace" },
110a111,115
>         "name": {
>             "description": "what a name can be",
>             "type": "string",
>             "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
>         },
bash-3.2$ diff dot_samples/original/json-home.json dot_samples/schemas/json-home.json 
95c95
<                     "uniqueItems": "true",

---
>                     "uniqueItems": true,
102c102
<                     "uniqueItems": "true",

---
>                     "uniqueItems": true,
114c114
<                     "uniqueItems": "true",

---
>                     "uniqueItems": true,
bash-3.2$ diff dot_samples/original/crs.json dot_samples/schemas/crs.json 
32c32
<         "linkObject": {

---
>         "linkedObject": {
47c47
<         "linkedCRS": {

---
>         "linkedCrs": {

JSON-stat?

How difficult would it be to write a schema for http://json-stat.org/format/ ?

Updates to JSON-RPC 2.0 Schemas

Hi, these items need addressing in the schemas:

Request: This needs to be either a single instance of the current definition, or an unbound array of such objects (batch). Other than that I think it looks good.

Response: Result can be any type, not just an object. Same thing about batch, and needing to be an instance or an array of instances.

Handling in general should be to use the confirm the object shape, but not exclude any additional data fields.