Allow attribute to be used, but not to show up in the schema (graphiti-api#12)

zeisler · richmolj · commit 24fb10d35101 · 2019-08-08T11:40:12.000-04:00
* Allow "null" to be passed in filters Docs for PR graphiti-api/graphiti#158 * Update guides/concepts/resources.md Grammar fix
diff --git a/guides/concepts/resources.md b/guides/concepts/resources.md
@@ -82,8 +82,8 @@ attribute :first_name, :string
 
 {% include h.html tag="h4" text="2.1 Limiting Behavior" a="limiting-behavior" %}
 
-Each attribute consists of four flags: `readable`, `writable`,
-`sortable`, and `filterable`. Any of these flags can be turned off:
+Each attribute consists of five flags: `readable`, `writable`,
+`sortable`, `filterable`, and `schema`. Any of these flags can be turned off:
 
 {% highlight ruby %}
 attribute :name, :string, sortable: false
@@ -96,6 +96,9 @@ attribute :name, :string, only: [:sortable]
 attribute :name, :string, except: [:writable]
 {% endhighlight %}
 
+The `schema` flag is not affected by `only/except` options. 
+This option determines if the attribute is exported to the schema.json.
+
 You might want to allow behavior only if a certain condition is met.
 Pass a symbol to guard this behavior via corresponding method, only allowing the
 behavior if the method returns `true`:
@@ -130,6 +133,7 @@ self.attributes_readable_by_default = false # default true
 self.attributes_writable_by_default = false # default true
 self.attributes_filterable_by_default = false # default true
 self.attributes_sortable_by_default = false # default true
+self.attributes_schema_by_default = false # default true
 {% endhighlight %}
 
 {% include h.html tag="h4" text="2.3 Customizing Display" a="customizing-display" %}
