Merge "Chsnge to OpenApi 3.0"

[cps.git] / docs / modeling.rst

diff --git a/docs/modeling.rst b/docs/modeling.rst
index 80cfdea..6d31f83 100644 (file)
--- a/docs/modeling.rst
+++ b/docs/modeling.rst
@@ -56,9 +56,11 @@ Data
 Querying
 
 - **CPS Path** is used to query data nodes.
+
 .. toctree::
    :maxdepth: 1
 
+   xpath.rst
    cps-path.rst
 
 .. Below Label is used by documentation for other CPS components to link here, do not remove even if it gives a warning
@@ -83,6 +85,20 @@ Basic Concepts
 
     These are stored as Anchors within CPS-Core.
 
+    - **CM-Handle States** are used to represent the potential states in which a CM-Handle can transition between.
+
+        The 5 possible CM-Handle states are: ADVISED, READY, LOCKED, DELETING, DELETED
+
+        **ADVISED** indicates that a CM-Handle has been registered successfully, and is waiting for the module synchronization process to sync the CM-Handle.
+
+        **READY** indicates that the CM-Handle has been synced successfully.
+
+        **LOCKED** indicates that the CM-Handle has not synced successfully. A retry mechanism within CPS will set the state back to ADVISED after a set time.
+
+        **DELETING** indicates that the CM-Handle is currently being deleted.
+
+        **DELETED** indicates that the CM-Handle has been deleted successfully.
+
     - **Data-sync state** is the state of the data synchronization process of the CM-Handle
 
         There are 3 possibles states: NONE_REQUESTED, UNSYNCHRONIZED, SYNCHRONIZED
@@ -108,7 +124,10 @@ Basic Concepts
 Querying CM Handles
 
 - **CM Handle Searches Endpoints** are used to query CM Handles.
+
 .. toctree::
    :maxdepth: 1
 
-   ncmp-cmhandle-querying.rst
\ No newline at end of file
+   ncmp-cmhandle-querying.rst
+   ncmp-inventory-querying.rst
+   cps-scheduled-processes.rst