An example product in this API is:
-++{ "id": 1, "name": "A green door", "price": 12.50, "tags": ["home", "green"] } -
While generally straightforward, that example leaves some open questions. For example, one may ask:
@@ -34,14 +34,14 @@To start a schema definition, let's begin with a basic JSON schema:
-++{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Product", "description": "A product from Acme's catalog", "type": "object" } -
The above schema has four properties called keywords. @@ -64,7 +64,7 @@
id is a numeric value that uniquely identifies a product. Since this is the canonical identifier for a product, it doesn't make sense to have a product without one, so it is required.
In JSON Schema terms, we can update our schema to:
-++{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Product", @@ -78,13 +78,13 @@What is id?
}, "required": ["id"] } -
name is a string value that describes a product. Since there isn't much to a product without a name, it also is required. Adding this gives us the schema:
-++{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Product", @@ -102,12 +102,12 @@Is name required?
}, "required": ["id", "name"] } -
According to Acme's docs, there are no free products. In JSON schema a number can have a minimum. By default this minimum is inclusive, so we need to specify exclusiveMinimum. Therefore we can update our schema with price:
-++{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Product", @@ -130,7 +130,7 @@Can price be 0?
}, "required": ["id", "name", "price"] } -
Finally, we come to the tags property. Unlike the previous @@ -148,7 +148,7 @@
The first constraint can be added with minItems, and the second one by specifying uniqueItems as being true:
-++{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Product", @@ -179,7 +179,7 @@Are all tags strings?
}, "required": ["id", "name", "price"] } -
And also, since JSON Schema defines a reference schema for a geographic location, instead of coming up with our own, we'll reference the canonical one.
++[ { "id": 2, @@ -221,10 +221,10 @@Set of products:
} } ] -
+diff --git a/example2.html b/example2.html index daad1d91..292574ec 100644 --- a/example2.html +++ b/example2.html @@ -10,7 +10,7 @@+{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "Product set", @@ -270,6 +270,6 @@Set of products schema:
"required": ["id", "name", "price"] } } -
An entry in the fstab file can have many different forms. Here is a possible representation of a full fstab:
-++{ "/": { "storage": { @@ -42,7 +42,7 @@Purpose
} } } -
Not all constraints to an fstab file can be modeled using JSON Schema alone; however, it can already represent a good number of them. We will add constraints one after the other until we get to @@ -62,7 +62,7 @@
We also want the schema to be regarded as a draft v4 schema, we must therefore specify $schema:
-++{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", @@ -75,7 +75,7 @@Base schema
"additionalProperties": false, "required": [ "/" ] } -
Note how the valid paths constraint is enforced here:
@@ -100,7 +100,7 @@Here again we will proceed step by step. We will start with the global structure of our schema, which will be as such:
-++{ "id": "http://some.site.somewhere/entry-schema#", "$schema": "http://json-schema.org/draft-04/schema#", @@ -125,7 +125,7 @@The entry schema - starting out
"tmpfs": {} } } -
You should already be familiar with some of the constraints:
@@ -167,7 +167,7 @@With these added constraints, the schema now looks like this:
-++{ "id": "http://some.site.somewhere/entry-schema#", "$schema": "http://json-schema.org/draft-04/schema#", @@ -202,7 +202,7 @@The entry schema - adding constraints
"tmpfs": {} } } -
For now, all definitions are empty (an empty JSON Schema validates all instances). We will write schemas for individual definitions below, and fill these schemas into the entry schema.
@@ -214,7 +214,7 @@++{ "properties": { "type": { "enum": [ "disk" ] }, @@ -226,7 +226,7 @@The diskDevice storage type
"required": [ "type", "device" ], "additionalProperties": false } -
You will have noted that we need not specify that type must be a string: the constraint described by enum is enough.
@@ -238,7 +238,7 @@This storage type has two required properties, type and label. The type can only be disk, and the label must be a valid UUID. No other properties are allowed:
-++{ "properties": { "type": { "enum": [ "disk" ] }, @@ -250,7 +250,7 @@The diskUUID storage type
"required": [ "type", "label" ], "additionalProperties": false } -
For the constraints on server, we use a new keyword: format. While it is not required that format be supported, we will suppose that it is here:
-++{ "properties": { "type": { "enum": [ "nfs" ] }, @@ -282,7 +282,7 @@The nfs storage type
"required": [ "type", "server", "remotePath" ], "additionalProperties": false } -
++{ "properties": { "type": { "enum": [ "tmpfs" ] }, @@ -304,7 +304,7 @@The tmpfs storage type
"required": [ "type", "sizeInMB" ], "additionalProperties": false } -
The resulting schema is quite large:
++{ "id": "http://some.site.somewhere/entry-schema#", "$schema": "http://json-schema.org/draft-04/schema#", @@ -396,7 +396,7 @@The full entry schema
} } } -
Now that all possible entries have been described, we can refer to the entry schema from our main schema. We will, again, use a JSON Reference here:
-++{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", @@ -417,7 +417,7 @@Plugging this into our main schema
"additionalProperties": false, "required": [ "/" ] } -
Here is a basic example of a JSON Schema: -
++{ "title": "Example Schema", "type": "object", @@ -24,7 +24,7 @@Basic example
}, "required": ["firstName", "lastName"] } -
The most basic schema is a blank JSON object, which constrains nothing, allows anything, and describes nothing:
-{}
-{}You can apply constraints on an instance by adding validation keywords to the schema. For instance, the "type" keyword can be used to restrict an instance to an object, array, string, number, boolean, or null:
-{ "type": "string" }
-{"type": "string"}JSON Schema is hypermedia ready, and ideal for annotating your existing JSON-based HTTP API. JSON Schema documents are identified by URIs, which can be used in HTTP Link headers, and inside JSON Schema documents to allow recursive definitions.
diff --git a/js/prism.js b/js/prism.js new file mode 100644 index 00000000..1c4e252d --- /dev/null +++ b/js/prism.js @@ -0,0 +1,4 @@ +/* http://prismjs.com/download.html?themes=prism&languages=json&plugins=normalize-whitespace */ +var _self="undefined"!=typeof window?window:"undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope?self:{},Prism=function(){var e=/\blang(?:uage)?-(\w+)\b/i,t=0,n=_self.Prism={util:{encode:function(e){return e instanceof a?new a(e.type,n.util.encode(e.content),e.alias):"Array"===n.util.type(e)?e.map(n.util.encode):e.replace(/&/g,"&").replace(/e.length)break e;if(!(v instanceof a)){u.lastIndex=0;var b=u.exec(v),k=1;if(!b&&h&&m!=r.length-1){if(u.lastIndex=y,b=u.exec(e),!b)break;for(var w=b.index+(c?b[1].length:0),_=b.index+b[0].length,A=m,P=y,j=r.length;j>A&&_>P;++A)P+=r[A].length,w>=P&&(++m,y=P);if(r[m]instanceof a||r[A-1].greedy)continue;k=A-m,v=e.slice(y,P),b.index-=y}if(b){c&&(f=b[1].length);var w=b.index+f,b=b[0].slice(f),_=w+b.length,O=v.slice(0,w),x=v.slice(_),S=[m,k];O&&S.push(O);var N=new a(l,g?n.tokenize(b,g):b,d,b,h);S.push(N),x&&S.push(x),Array.prototype.splice.apply(r,S)}}}}}return r},hooks:{all:{},add:function(e,t){var a=n.hooks.all;a[e]=a[e]||[],a[e].push(t)},run:function(e,t){var a=n.hooks.all[e];if(a&&a.length)for(var r,i=0;r=a[i++];)r(t)}}},a=n.Token=function(e,t,n,a,r){this.type=e,this.content=t,this.alias=n,this.length=0|(a||"").length,this.greedy=!!r};if(a.stringify=function(e,t,r){if("string"==typeof e)return e;if("Array"===n.util.type(e))return e.map(function(n){return a.stringify(n,t,e)}).join("");var i={type:e.type,content:a.stringify(e.content,t,r),tag:"span",classes:["token",e.type],attributes:{},language:t,parent:r};if("comment"==i.type&&(i.attributes.spellcheck="true"),e.alias){var l="Array"===n.util.type(e.alias)?e.alias:[e.alias];Array.prototype.push.apply(i.classes,l)}n.hooks.run("wrap",i);var o=Object.keys(i.attributes).map(function(e){return e+'="'+(i.attributes[e]||"").replace(/"/g,""")+'"'}).join(" ");return"<"+i.tag+' class="'+i.classes.join(" ")+'"'+(o?" "+o:"")+">"+i.content+""},!_self.document)return _self.addEventListener?(_self.addEventListener("message",function(e){var t=JSON.parse(e.data),a=t.language,r=t.code,i=t.immediateClose;_self.postMessage(n.highlight(r,n.languages[a],a)),i&&_self.close()},!1),_self.Prism):_self.Prism;var r=document.currentScript||[].slice.call(document.getElementsByTagName("script")).pop();return r&&(n.filename=r.src,document.addEventListener&&!r.hasAttribute("data-manual")&&("loading"!==document.readyState?window.requestAnimationFrame?window.requestAnimationFrame(n.highlightAll):window.setTimeout(n.highlightAll,16):document.addEventListener("DOMContentLoaded",n.highlightAll))),_self.Prism}();"undefined"!=typeof module&&module.exports&&(module.exports=Prism),"undefined"!=typeof global&&(global.Prism=Prism); +Prism.languages.json={property:/"(?:\\.|[^|"])*"(?=\s*:)/gi,string:/"(?!:)(?:\\.|[^|"])*"(?!:)/g,number:/\b-?(0x[\dA-Fa-f]+|\d*\.?\d+([Ee][+-]?\d+)?)\b/g,punctuation:/[{}[\]);,]/g,operator:/:/g,"boolean":/\b(true|false)\b/gi,"null":/\bnull\b/gi},Prism.languages.jsonp=Prism.languages.json; +!function(){function e(e){this.defaults=r({},e)}function n(e){return e.replace(/-(\w)/g,function(e,n){return n.toUpperCase()})}function t(e){for(var n=0,t=0;t