docs(graffiti-model): add documentation for graffiti model

RisingStack · Oct 12, 2015 · 73ec052 · 73ec052
1 parent 477105b
commit 73ec052
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/src/model/README.md b/src/model/README.md
@@ -0,0 +1,27 @@
+## Graffiti Model
+
+```javascript
+{
+  Name: {
+    name: String!,
+    description: String?,
+    fields: {
+      fieldName: {
+        name: String? // default: key
+        description: String?,
+        nonNull: Boolean?, // required?
+        hidden: Boolean? // included in the GraphQL schema
+        type: String('String'|'Number'|'Date'|'Buffer'|'Boolean'|'ObjectID'|'Object'|'Array'),
+        // if type == Array
+        subtype: String('String'|'Number'|'Date'|'Buffer'|'Boolean'|'ObjectID'|'Object'|'Array'),
+        // if type == Object
+        fields: {
+          // ...
+        },
+        // if type == ObjectID
+        reference: String!
+      }
+    }
+  }
+}
+```