event-protocol: Tidy up schema titles and add descriptions (#127)

cucumber · Mar 4, 2017 · a920f06 · a920f06
1 parent d073e7b
commit a920f06
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 2 deletions.
diff --git a/event-protocol/schemas/attachment.json b/event-protocol/schemas/attachment.json
@@ -1,6 +1,7 @@
 {
   "id": "https://raw.github.com/cucumber/cucumber/master/event-protocol/schemas/attachment.json#",
-  "title": "source",
+  "title": "attachment",
+  "description": "Event describing a specification document, containing executable examples",
   "type": "object",
   "properties": {
     "type": {

diff --git a/event-protocol/schemas/defs.json b/event-protocol/schemas/defs.json
@@ -1,7 +1,7 @@
 {
   "id": "https://raw.github.com/cucumber/cucumber/master/event-protocol/schemas/defs.json#",
   "title": "definitions",
-  "description": "re-usable parts of the schema",
+  "description": "Re-usable parts of the schema, referenced by others",
   "timestamp": {
     "description": "Milliseconds since epoch",
     "type": "integer",

diff --git a/event-protocol/schemas/source.json b/event-protocol/schemas/source.json
@@ -1,6 +1,7 @@
 {
   "id": "https://raw.github.com/cucumber/cucumber/master/event-protocol/schemas/source.json#",
   "title": "source",
+  "description": "Describes a specification document that contains executable examples",
   "type": "object",
   "properties": {
     "type": {

diff --git a/event-protocol/schemas/start.json b/event-protocol/schemas/start.json
@@ -1,6 +1,7 @@
 {
   "id": "https://raw.github.com/cucumber/cucumber/master/event-protocol/schemas/start.json#",
   "title": "start",
+  "description": "Signals the start of an event stream",
   "type": "object",
   "properties": {
     "type": {