Gh-527: Document DeleteAllData changes (#528)

* update docs * address comment
gchq · Aug 29, 2024 · 9e960f0 · 9e960f0
1 parent 7765407
commit 9e960f0
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 10 deletions.
diff --git a/docs/reference/gremlin-guide/gaffer-options.md b/docs/reference/gremlin-guide/gaffer-options.md
@@ -11,11 +11,21 @@ Allows passing options to the underlying Gaffer Operations, this is the same as
 the `options` field on a standard JSON query. This will be applied to all
 operations in the query.
 
+Note that any options should be passed as a list or dictionary.
+
 !!! example
 
-    ```groovy
-    g.with("operationOptions", "gaffer.federatedstore.operation.graphIds:graphA").V().toList()
-    ```
+    === "Groovy"
+
+        ```groovy
+        g.with("operationOptions", ["gaffer.federatedstore.operation.graphIds:graphA"]).V().toList()
+        ```
+
+    === "Python"
+
+        ```python
+        g.with_("operationOptions", {"gaffer.federatedstore.operation.graphIds:graphA"}).V().to_list()
+        ```
 
 ## GetAllElements Limit
 

diff --git a/docs/reference/operations-guide/core.md b/docs/reference/operations-guide/core.md
@@ -104,7 +104,9 @@ Adds elements to a graph. [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/ga
 
 ## DeleteElements
 
-Deletes Elements from a graph.
+Deletes Elements from a graph. [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/operation/impl/delete/DeleteElements.html)
+
+Note that this operation does not return any response.
 
 ??? example "Example deleting an entity and edge"
 
@@ -4625,13 +4627,8 @@ Gets the traits of the current store. [Javadoc](https://gchq.github.io/Gaffer/uk
 
 ## DeleteAllData
 
-!!! warning
-    This operation is currently only implemented for Accumulo stores.
-
 Deletes all retained data including deleting the graph. [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/store/operation/DeleteAllData.html)
 
-To use this operation, it must be enabled via an [operations declarations JSON](../../administration-guide/gaffer-config/config.md#operations-declarations-json).
-
 Note this operation does not return any response.
 
 ```json title="operationsDeclarations.json"

diff --git a/docs/reference/operations-guide/operations.md b/docs/reference/operations-guide/operations.md
@@ -11,6 +11,7 @@ These pages contain examples of most operations in Gaffer. The examples are give
 Operation | Type
 ------------- | -------------
 [`operation.impl.add.AddElements`](core.md#addelements) | Core
+[`operation.impl.delete.DeleteElements`](core.md#deleteelements) | Core
 [`operation.impl.get.GetAdjacentIds`](get.md#getadjacentids) | Get
 [`operation.impl.get.GetAllElements`](get.md#getallelements) | Get
 [`operation.impl.get.GetElements`](get.md#getelements) | Get
@@ -28,6 +29,7 @@ Operation | Type
 [`operation.impl.function.Transform`](core.md#transform) | Core
 `operation.impl.GetVariable` | Core
 `operation.impl.GetVariables` | Core
+[`operation.impl.get.GetGraphCreatedTime`](core.md#getgraphcreatedtime) | Core
 [`operation.impl.Limit`](core.md#limit) | Core
 `operation.impl.Map` | Core
 [`operation.impl.Reduce`](core.md#reduce) | Core
@@ -79,7 +81,7 @@ Operation | Type
 [`named.view.AddNamedView`](named.md#addnamedview) | Named
 [`named.view.DeleteNamedView`](named.md#deletenamedview) | Named
 [`named.view.GetAllNamedViews`](named.md#getallnamedviews) | Named
-[`store.operation.DeleteAllData`](core.md#deletealldata) | Store
+[`store.operation.DeleteAllData`](core.md#deletealldata) | Core
 [`store.operation.GetSchema`](core.md#getschema) | Store
 [`store.operation.GetTraits`](core.md#gettraits) | Store
 `store.operation.HasTrait` | Store