Make the entry actions more discoverable

Group them under st2.kv.entry.*

Signed-off-by: Jacob Floyd <[email protected]>

Author: cognifloyd

README.md

@@ -43,18 +43,18 @@ You can also use dynamic values from the datastore. See the
 * ``kv.grep_object`` - Find datastore items which name matches the provided query
   amd deserialize their values from JSON serialized objects.
 
-* ``kv.get_entry`` - Retrieve entry object in a JSON serialized object from the
+* ``kv.entry.get`` - Retrieve entry in a JSON serialized object from the
   datastore. An entry is a standard JSON object with properties.
   Fails if the datastore key does not exist.
-* ``kv.upsert_entry_property`` - Update or insert a property in the named entry
+* ``kv.entry.upsert_property`` - Update or insert a property in the named entry
   of a JSON serialized object. Then, serialize and store the updated object.
   The property's value may be any json-serializable type.
   Fails if the datastore key does not exist. A coordination backend is recommended.
-* ``kv.append_entry_property`` - Add the value to the end of an array property
+* ``kv.entry.append_property`` - Add the value to the end of an array property
   in the named entry of a JSON serialized object. Then, serialize and store the
   updated object. The property must be an array. The value to append can be anything.
   Fails if the datastore key does not exist. A coordination backend is recommended.
-* ``kv.delete_entry_property`` - Delete a property from a named entry of a JSON
+* ``kv.entry.delete_property`` - Delete a property from a named entry of a JSON
   serialized object in the datastore. If the entry is empty, delete it as well.
   Fails if the datastore key does not exist. A coordination backend is recommended.
 

actions/kv_append_entry_property.py renamed to actions/kv_entry_append_property.py

@@ -5,11 +5,11 @@
 from lib.action import St2BaseAction
 
 __all__ = [
-    'St2KVPAppendEntryPropertyAction'
+    'St2KVPEntryAppendPropertyAction'
 ]
 
 
-class St2KVPAppendEntryPropertyAction(St2BaseAction):
+class St2KVPEntryAppendPropertyAction(St2BaseAction):
     # noinspection PyShadowingBuiltins
     def run(self, key, entry, property, value):
         with coordination_service.get_coordinator().get_lock('st2.kv_entry.' + key):

actions/kv_append_entry_property.yaml renamed to actions/kv_entry_append_property.yaml

@@ -1,5 +1,5 @@
 ---
-name: 'kv.append_entry_property'
+name: 'kv.entry.append_property'
 enabled: true
 description: |
   Add a value to the end of an array property under a named entry (sub-object)
@@ -9,7 +9,7 @@ description: |
   This action does not support encrypted datastore objects.
 
 runner_type: python-script
-entry_point: kv_append_entry_property.py
+entry_point: kv_entry_append_property.py
 parameters:
   key:
     required: true

actions/kv_delete_entry_property.py renamed to actions/kv_entry_delete_property.py

@@ -5,11 +5,11 @@
 from lib.action import St2BaseAction
 
 __all__ = [
-    'St2KVPDeleteEntryPropertyAction'
+    'St2KVPEntryDeletePropertyAction'
 ]
 
 
-class St2KVPDeleteEntryPropertyAction(St2BaseAction):
+class St2KVPEntryDeletePropertyAction(St2BaseAction):
     # noinspection PyShadowingBuiltins
     def run(self, key, entry, property):
         with coordination_service.get_coordinator().get_lock('st2.kv_entry.' + key):

actions/kv_delete_entry_property.yaml renamed to actions/kv_entry_delete_property.yaml

@@ -1,5 +1,5 @@
 ---
-name: 'kv.delete_entry_property'
+name: 'kv.entry.delete_property'
 enabled: true
 description: |
   Delete a property (if it exists) under a named entry (sub-object) of a
@@ -10,7 +10,7 @@ description: |
   This action does not support encrypted datastore objects.
 
 runner_type: python-script
-entry_point: kv_delete_entry_property.py
+entry_point: kv_entry_delete_property.py
 parameters:
   key:
     required: true

actions/kv_get_entry.py renamed to actions/kv_entry_get.py

@@ -3,11 +3,11 @@
 from lib.action import St2BaseAction
 
 __all__ = [
-    'St2KVPGetEntryAction'
+    'St2KVPEntryGetAction'
 ]
 
 
-class St2KVPGetEntryAction(St2BaseAction):
+class St2KVPEntryGetAction(St2BaseAction):
     # noinspection PyShadowingBuiltins
     def run(self, key, entry, fallback):
         # get and deserialize object or fail.

actions/kv_get_entry.yaml renamed to actions/kv_entry_get.yaml

@@ -1,5 +1,5 @@
 ---
-name: 'kv.get_entry'
+name: 'kv.entry.get'
 enabled: true
 description: |
   Get a named entry (sub-object) of a serialized object in kv datastore
@@ -10,7 +10,7 @@ description: |
   This action does not support encrypted datastore objects.
 
 runner_type: python-script
-entry_point: kv_get_entry.py
+entry_point: kv_entry_get.py
 parameters:
   key:
     required: true

actions/kv_upsert_entry_property.py renamed to actions/kv_entry_upsert_property.py

@@ -5,11 +5,11 @@
 from lib.action import St2BaseAction
 
 __all__ = [
-    'St2KVPUpsertEntryPropertyAction'
+    'St2KVPEntryUpsertPropertyAction'
 ]
 
 
-class St2KVPUpsertEntryPropertyAction(St2BaseAction):
+class St2KVPEntryUpsertPropertyAction(St2BaseAction):
     # noinspection PyShadowingBuiltins
     def run(self, key, entry, property, value):
         with coordination_service.get_coordinator().get_lock('st2.kv_entry.' + key):

actions/kv_upsert_entry_property.yaml renamed to actions/kv_entry_upsert_property.yaml

@@ -1,5 +1,5 @@
 ---
-name: 'kv.upsert_entry_property'
+name: 'kv.entry.upsert_property'
 enabled: true
 description: |
   Insert or update a property under a named entry (sub-object) of a serialized object in kv datastore.
@@ -8,7 +8,7 @@ description: |
   This action does not support encrypted datastore objects.
 
 runner_type: python-script
-entry_point: kv_upsert_entry_property.py
+entry_point: kv_entry_upsert_property.py
 parameters:
   key:
     required: true