Improve experience when accessing schemas from web browser

adamvoss · handrews · commit 09f15366a57d · 2017-05-15T21:32:19.000-07:00
This adds a .json file where it has been indicated as allowable and a notice elsewhere.
diff --git a/address b/address
diff --git a/address b/address
@@ -0,0 +1 @@
+example/address.json
diff --git a/calendar b/calendar
diff --git a/calendar b/calendar
@@ -0,0 +1 @@
+example/calendar.json
diff --git a/card b/card
diff --git a/card b/card
@@ -0,0 +1 @@
+example/card.json
diff --git a/documentation.md b/documentation.md
@@ -17,11 +17,11 @@ For previous versions of the specification, please see the [Specification Links]
 Meta-schemas
 ------------
 
-The meta-schemas are the schemas which define the JSON Schema and Hyper-Schema formats.
-
+The meta-schemas define the JSON Schema and Hyper-Schema formats using the JSON Schema format.
 The latest meta-schema is draft-06.
 
 |--------------------------------------------------------------|------------------------------------------------------------|
 | [Core/Validation Meta-Schema](http://json-schema.org/schema) | Used for schemas written for pure validation.              |
 | [Hyper Meta-Schema](http://json-schema.org/hyper-schema)     | Used for schemas written for validation and hyper-linking. |
 
+**If you are accessing the above meta-schema links from a web browser, you will need to save the file then open it as a JSON file.**
diff --git a/example/address.json b/example/address.json
@@ -0,0 +1,19 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "An Address following the convention of http://microformats.org/wiki/hcard",
+    "type": "object",
+    "properties": {
+        "post-office-box": { "type": "string" },
+        "extended-address": { "type": "string" },
+        "street-address": { "type": "string" },
+        "locality":{ "type": "string" },
+        "region": { "type": "string" },
+        "postal-code": { "type": "string" },
+        "country-name": { "type": "string"}
+    },
+    "required": ["locality", "region", "country-name"],
+    "dependencies": {
+        "post-office-box": ["street-address"],
+        "extended-address": ["street-address"]
+    }
+}
diff --git a/example/calendar.json b/example/calendar.json
@@ -0,0 +1,38 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "A representation of an event",
+    "type": "object",
+    "required": [ "dtstart", "summary" ],
+    "properties": {
+        "dtstart": {
+            "format": "date-time",
+            "type": "string",
+            "description": "Event starting time"
+        },
+        "dtend": {
+            "format": "date-time",
+            "type": "string",
+            "description": "Event ending time"
+        },
+        "summary": { "type": "string" },
+        "___location": { "type": "string" },
+        "url": { "type": "string", "format": "uri" },
+        "duration": {
+            "format": "time",
+            "type": "string",
+            "description": "Event duration"
+        },
+        "rdate": {
+            "format": "date-time",
+            "type": "string",
+            "description": "Recurrence date"
+        },
+        "rrule": {
+            "type": "string",
+            "description": "Recurrence rule"
+        },
+        "category": { "type": "string" },
+        "description": { "type": "string" },
+        "geo": { "$ref": "http: //json-schema.org/geo" }
+    }
+}
diff --git a/example/card.json b/example/card.json
@@ -0,0 +1,49 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "A representation of a person, company, organization, or place",
+    "type": "object",
+    "required": ["familyName", "givenName"],
+    "properties": {
+        "fn": {
+            "description": "Formatted Name",
+            "type": "string"
+        },
+        "familyName": { "type": "string" },
+        "givenName": { "type": "string" },
+        "additionalName": { "type": "array", "items": { "type": "string" } },
+        "honorificPrefix": { "type": "array", "items": { "type": "string" } },
+        "honorificSuffix": { "type": "array", "items": { "type": "string" } },
+        "nickname": { "type": "string" },
+        "url": { "type": "string", "format": "uri" },
+        "email": {
+            "type": "object",
+            "properties": {
+                "type": { "type": "string" },
+                "value": { "type": "string", "format": "email" }
+            }
+        },
+        "tel": {
+            "type": "object",
+            "properties": {
+                "type": { "type": "string" },
+                "value": { "type": "string", "format": "phone" }
+            }
+        },
+        "adr": { "$ref": "http://json-schema.org/address" },
+        "geo": { "$ref": "http://json-schema.org/geo" },
+        "tz": { "type": "string" },
+        "photo": { "type": "string" },
+        "logo": { "type": "string" },
+        "sound": { "type": "string" },
+        "bday": { "type": "string", "format": "date" },
+        "title": { "type": "string" },
+        "role": { "type": "string" },
+        "org": {
+            "type": "object",
+            "properties": {
+                "organizationName": { "type": "string" },
+                "organizationUnit": { "type": "string" }
+            }
+        }
+    }
+}
diff --git a/example/geo.json b/example/geo.json
@@ -0,0 +1,9 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "A geographical coordinate",
+    "type": "object",
+    "properties": {
+        "latitude": { "type": "number" },
+        "longitude": { "type": "number" }
+    }
+}
diff --git a/examples.md b/examples.md
@@ -31,11 +31,11 @@ Example schemas
 
 These sample schemas describe simple data structures which can be expressed as JSON:
 
-|-----------------------------------------------------|---------------------------------------------------------------------------------|
-| [Geographic Coordinate](http://json-schema.org/geo) | a ___location as longitude and latitude                                            |
-| [Card](http://json-schema.org/card)                 | a microformat-style representation of a person, company, organization, or place |
-| [Calendar](http://json-schema.org/calendar)         | a microformat-style representation of an event                                  |
-| [Address](http://json-schema.org/address)           | a microformat-style representation of a street address                          |
+|------------------------------------------------------------------------------|-----------------------------------------------------------------|
+| [Geographic Coordinate][geo.json] <br> [<small>(canonical url)</small>][geo] | a ___location as longitude and latitude                            |
+| [Card][card.json] <br> [<small>(canonical url)</small>][card]                | a microformat-style representation of a person, company, organization, or place |
+| [Calendar][cal.json] <br> [<small>(canonical url)</small>][cal]              | a microformat-style representation of an event                  |
+| [Address][addr.json] <br> [<small>(canonical url)</small>][addr]             | a microformat-style representation of a street address          |
 
 Walkthroughs
 ------------
@@ -46,3 +46,13 @@ The two examples below are step-by-step guides into building a schema:
 -   [a more advanced example](example2.md), using JSON Schema to describe filesystem entries in a Unix-like /etc/fstab file.
 
 The [Space Telescope Science Institute](http://www.stsci.edu/) has also published a [guide aimed at schema authors](http://spacetelescope.github.io/understanding-json-schema/).
+
+
+[geo.json]: example/geo.json
+[card.json]: example/card.json
+[cal.json]: example/calendar.json
+[addr.json]: example/address.json
+[geo]: geo
+[card]: card
+[cal]: calendar
+[addr]: address
diff --git a/geo b/geo
diff --git a/geo b/geo
@@ -0,0 +1 @@
+example/geo.json
