@@ -45,7 +45,7 @@ Graph Store can be poked with a `graph-update`, which can:
48−What follows is a summary of the scrys available in graph-store
48+What follows is a summary of the scries available in graph-store.
50<!-- enhancement: add examples -->
50<!-- enhancement: add examples -->
51<!-- enhancement: add refrences to relevant sections in data structures explanation -->
51<!-- enhancement: add refrences to relevant sections in data structures explanation -->
@@ -53,28 +53,28 @@ What follows is a summary of the scrys available in graph-store
54### Export State
54### Export State
56−Obtain a vase of the current state of graph-store as a noun
56+Obtain a vase of the current state of graph-store as a noun.
58* Path: `/x/export`
58* Path: `/x/export`
59* Output Type: `network:store`
59* Output Type: `network:store`
61### Fetch keys
61### Fetch keys
63−Fetch the resources of all graphs that graph-store is currently tracking
63+Fetch the resources of all graphs that graph-store is currently tracking.
65* Path: `/x/keys`
65* Path: `/x/keys`
66* Output Type: `(set resource)`
66* Output Type: `(set resource)`
68### Fetch tag queries
68### Fetch tag queries
70−Fetch the available tag queries from graph-store
70+Fetch the available tag queries from graph-store.
72* Path: `/x/tag-queries`
72* Path: `/x/tag-queries`
73* Output Type: `tag-queries`
73* Output Type: `tag-queries`
75### Fetch tags
75### Fetch tags
77−Fetch all available tags from graph-store
77+Fetch all available tags from graph-store.
79* Path: `/x/tag-queries/tags`
79* Path: `/x/tag-queries/tags`
80* Output Type: `(list term)`
80* Output Type: `(list term)`
@@ -105,7 +105,7 @@ Fetch the time of the latest log entry by resource, if the update-log for the gi
106 * **ship** (`ship`) - The ship of the resource.
106 * **ship** (`ship`) - The ship of the resource.
107 * **name** (`@tas`) - The name of the resource.
107 * **name** (`@tas`) - The name of the resource.
108− * **start** and **end** (`@da`) - all logs after **start** and before **end** are to be included in the result
108+ * **start** and **end** (`@da`) - All logs after **start** and before **end** are to be included in the result.
109* Output Type: `update-log:store`
109* Output Type: `update-log:store`
111### Fetch a specific graph by resource
111### Fetch a specific graph by resource
@@ -134,12 +134,11 @@ Returns the mark associated a given graph, if one exists.
134Returns a subset of nodes from a graph, with or without descendants, optionally filtering for ones that fall between the start and end indexes.
134Returns a subset of nodes from a graph, with or without descendants, optionally filtering for ones that fall between the start and end indexes.
136* Path: `/x/graph/[ship]/[name]/subset/[mode]/[start?]/[end?]`
136* Path: `/x/graph/[ship]/[name]/subset/[mode]/[start?]/[end?]`
139 * **ship** (`ship`) - The ship of the resource.
138 * **ship** (`ship`) - The ship of the resource.
140 * **name** (`@tas`) - The name of the resource.
139 * **name** (`@tas`) - The name of the resource.
141− * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude
140+ * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude.
142− * **start** and **end** (`(unit atom)`) - Atoms used to start and end the subset. If these are unable to be parsed, the subset will start at the smallest node
141+ * **start** and **end** (`(unit atom)`) - Atoms used to start and end the subset. If these are unable to be parsed, the subset will start at the smallest node.
143* Output Type: `update:store` `%add-nodes`
142* Output Type: `update:store` `%add-nodes`
145### Check if node exists
144### Check if node exists
@@ -150,19 +149,19 @@ Returns a flag, `%.y` if the node exists and `%.n` otherwise.
151 * **ship** (`ship`) - The ship of the resource.
150 * **ship** (`ship`) - The ship of the resource.
152 * **name** (`@tas`) - The name of the resource.
151 * **name** (`@tas`) - The name of the resource.
153− * **[index+]** `(list atom)`- The index of the node to check. The index should be appended to the path as a list
152+ * **[index+]** `(list atom)`- The index of the node to check. The index should be appended to the path as a list.
154* Output Type: `flag`
153* Output Type: `flag`
156### Request a node
155### Request a node
158−Returns an `%add-nodes` update containing the node that was requested
157+Returns an `%add-nodes` update containing the node that was requested.
160* Path: `/x/graph/[ship]/[name]/node/index/[mode]/[index+]`
159* Path: `/x/graph/[ship]/[name]/node/index/[mode]/[index+]`
162 * **ship** (`ship`) - The ship of the resource.
161 * **ship** (`ship`) - The ship of the resource.
163 * **name** (`@tas`) - The name of the resource.
162 * **name** (`@tas`) - The name of the resource.
164 * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude
163 * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude
165− * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list
164+ * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list.
166* Output Type: `update:store` `%add-nodes`
165* Output Type: `update:store` `%add-nodes`
168### Request a node's children
167### Request a node's children
@@ -174,9 +173,9 @@ Returns a subset of a node's children, with or without descendants, optionally f
175 * **ship** (`ship`) - The ship of the resource.
174 * **ship** (`ship`) - The ship of the resource.
176 * **name** (`@tas`) - The name of the resource.
175 * **name** (`@tas`) - The name of the resource.
177− * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude
176+ * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude.
178− * **start** and **end** (`(unit atom)`) - Atoms used to start and end the subset. If these are unable to be parsed, the subset will start at the smallest node
177+ * **start** and **end** (`(unit atom)`) - Atoms used to start and end the subset. If these are unable to be parsed, the subset will start at the smallest node.
179− * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list
178+ * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list.
181* Output Type: `update:store` `%add-nodes`
180* Output Type: `update:store` `%add-nodes`
@@ -190,13 +189,13 @@ Returns a subset of a node's children, with or without descendants, optionally f
190 * **ship** (`ship`) - The ship of the resource.
189 * **ship** (`ship`) - The ship of the resource.
191 * **name** (`@tas`) - The name of the resource.
190 * **name** (`@tas`) - The name of the resource.
192 * **direction** (`?(%older %newer %oldest %newest)`)-
191 * **direction** (`?(%older %newer %oldest %newest)`)-
193− + `%newer` - load the siblings with keys larger than the requested node
192+ + `%newer` - Load the siblings with keys larger than the requested node.
194− + `%older` - load the siblings with keys smaller than the requested node
193+ + `%older` - Load the siblings with keys smaller than the requested node.
195− + `%newest` - load the siblings with the largest keys
194+ + `%newest` - Load the siblings with the largest keys.
196− + `%oldest` - load the siblings with the largest keys
195+ + `%oldest` - Load the siblings with the largest keys.
197− * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude
196+ * **mode** (`?(%kith %lone)`) - `%kith` to include descendants, `%lone` to exclude.
198− * **count** (`atom`) - a limit to the number of nodes to return
197+ * **count** (`atom`) - A limit to the number of nodes to return.
199− * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list
198+ * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list.
200* Output Type: `update:store` `%add-nodes`
199* Output Type: `update:store` `%add-nodes`
202### Request a node's firstborn child
201### Request a node's firstborn child
@@ -207,19 +206,18 @@ Returns a subset of a node's children, with or without descendants, optionally f
208 * **ship** (`ship`) - The ship of the resource.
207 * **ship** (`ship`) - The ship of the resource.
209 * **name** (`@tas`) - The name of the resource.
208 * **name** (`@tas`) - The name of the resource.
210− * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list
209+ * **[index+]** `(list atom)`- The index of the node being requested. The index should be appended to the path as a list.
212* Output: `update:store` `%add-nodes`
211* Output: `update:store` `%add-nodes`
214### Request nodes, depth first
213### Request nodes, depth first
216* Path: `/x/graph/[ship]/[name]/node/depth-first/[count]/[start]`
215* Path: `/x/graph/[ship]/[name]/node/depth-first/[count]/[start]`
219 * **ship** (`ship`) - The ship of the resource.
217 * **ship** (`ship`) - The ship of the resource.
220 * **name** (`@tas`) - The name of the resource.
218 * **name** (`@tas`) - The name of the resource.
221− * **count** (`(unit atom)`) - a limit to the number of nodes to return
219+ * **count** (`(unit atom)`) - A limit to the number of nodes to return.
222− * **start** (`(unit atom)`) - the index fragment to start at
220+ * **start** (`(unit atom)`) - The index fragment to start at.
224* Output Type: `update:store` `%add-nodes`
222* Output Type: `update:store` `%add-nodes`
@@ -241,7 +239,7 @@ The following is the definition of the agent state, known as `network`.
242- `graphs` represents all graphs that graph store is aware of an is storing data about.
240- `graphs` represents all graphs that graph store is aware of an is storing data about.
243- `tag-queries` is how graph store implements its tagging system, and uses it to keep track of associations between tags and the respective index.
241- `tag-queries` is how graph store implements its tagging system, and uses it to keep track of associations between tags and the respective index.
244−- `update-logs` is where graph-store stores the update-log that backs each graph, keyed by resource <!-- refrence to advanced section talking about how this is the source of truth -->
242+- `update-logs` is where graph-store stores the update-log that backs each graph, keyed by resource. <!-- refrence to advanced section talking about how this is the source of truth -->
245−- `archive` is where graph-store stores archived graphs. these are graphs which can no longer have updates run against them. <!-- this nuance should also be present in the advanced info -->
243+- `archive` is where graph-store stores archived graphs. These are graphs which can no longer be updated through `%run-updates`. <!-- this nuance should/could also be present in the advanced info -->
247For more information on these types, please take a look at the [data structure overview](/docs/userspace/graph-store/data-structure-overview).
245For more information on these types, please take a look at the [data structure overview](/docs/userspace/graph-store/data-structure-overview).