docs/ncmp-cmhandle-querying.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2022 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _cmhandlequerying:
   7
   8
   9 CM Handle Query Endpoints
  10 #########################
  11
  12 .. toctree::
  13    :maxdepth: 1
  14
  15 Introduction
  16 ============
  17
  18 For querying CM Handles we have two Post endpoints:
  19
  20 - ncmp/v1/ch/searches Returns all CM Handles which match the query properties provided. Gives a JSON payload of the **details** of all matching CM Handles.
  21
  22 - ncmp/v1/ch/id-searches Returns all CM Handles IDs which match the query properties provided. Gives a JSON payload of the **ids** of all matching CM Handles.
  23
  24 /searches returns whole CM Handle object (data) whereas /id-searches returns only CM Handle IDs. Otherwise these endpoints are intended to be functionally identical so both can be queried with the same request body. If no matching CM Handles are found an empty array is returned.
  25
  26 Request Body
  27 ============
  28
  29 Currently this endpoint allows three criteria to be query on:
  30
  31 - *hasAllModules* returns CM Handles which have the module names provided.
  32
  33 - *hasAllProperties* returns CM Handles which have the properties (key and value) provided.
  34
  35 - *cmHandleWithCpsPath* returns CM Handles which match the CPS Path provided.
  36
  37 Not all request body combinations have been validated and as such request bodies which do not conform to the structure as documented here can produce results in which all CM Handles are returned.
  38
  39 Casing conventions: 'camelCasing' and 'kebab-casing'
  40 ----------------------------------------------------
  41
  42 .. note::
  43     By convention REST JSON return bodies use 'camelCasing'. By convention field names in yang modelled data use 'kebab-casing'. Therefore some inconsistencies can be seen in the JSON use in CPS REST interfaces. For CM Handle related endpoints we return data in 'camelCasing'. But for *cmHandleWithCpsPath*, the query is accessing yang modelled field names and as such needs to use 'kebab-casing'. Therefore the dmi-registry field names should be referenced when using the *cmHandleWithCpsPath* condition: :doc:`modeling`
  44
  45 Request Body example using all available query criteria. This query would return all CM Handles which have the specified modules my-module-(1-3), have the specified properties of Color yellow, Shape circle, Size small and are in a sync state of ADVISED:
  46
  47 .. code-block:: json
  48
  49     {
  50       "cmHandleQueryParameters": [
  51         {
  52           "conditionName": "hasAllModules",
  53           "conditionParameters": [
  54             {
  55               "moduleName": "my-module-1"
  56             },
  57             {
  58               "moduleName": "my-module-2"
  59             },
  60             {
  61               "moduleName": "my-module-3"
  62             }
  63           ]
  64         },
  65         {
  66           "conditionName": "hasAllProperties",
  67           "conditionParameters": [
  68             {
  69               "Color": "yellow"
  70             },
  71             {
  72               "Shape": "circle"
  73             },
  74             {
  75               "Size": "small"
  76             }
  77           ]
  78         },
  79         {
  80           "conditionName": "cmHandleWithCpsPath",
  81           "conditionParameters": [
  82             {
  83               "cpsPath": "//state[@cm-handle-state='ADVISED']"
  84             }
  85           ]
  86         }
  87       ]
  88     }
  89
  90
  91 Has all Modules
  92 ---------------
  93
  94 With the *hasAllModules* condition, we can provide a list of module names. The CM Handles returned will have these module names. The parameter names must be as below with the key of each of the module names being "moduleName" where "my-module-X" is to be replaced with the name of the module to query with. The returned CM Handle must have all supplied modules. For the example request, a CM Handle will be returned if it has "my-module-1", "my-module-2" and "my-module-3".
  95
  96 .. code-block:: json
  97
  98     {
  99       "cmHandleQueryParameters": [
 100         {
 101           "conditionName": "hasAllModules",
 102           "conditionParameters": [
 103             {
 104               "moduleName": "my-module-1"
 105             },
 106             {
 107               "moduleName": "my-module-2"
 108             },
 109             {
 110               "moduleName": "my-module-3"
 111             }
 112           ]
 113         }
 114       ]
 115     }
 116
 117 Has all Properties
 118 ------------------
 119
 120 With the *hasAllProperties* condition, we can provide a list of property keys and values. The CM Handles returned will have these properties. The parameter names must be as below with key and value for each property. The returned CM Handle must have all supplied properties. For the example request, a CM Handle will be returned if it has properties where there is a key of "Color" with value "yellow", a key of "Shape" with value "circle" and a key of "Size" with value "small".
 121
 122 .. code-block:: json
 123
 124     {
 125       "cmHandleQueryParameters": [
 126         {
 127           "conditionName": "hasAllProperties",
 128           "conditionParameters": [
 129             {
 130               "Color": "yellow"
 131             },
 132             {
 133               "Shape": "circle"
 134             },
 135             {
 136               "Size": "small"
 137             }
 138           ]
 139         }
 140       ]
 141     }
 142
 143 CM Handle with CPS Path
 144 -----------------------
 145
 146 The *cmHandleWithCpsPath* condition allows any data of the CM Handle to be queried as long as it is accessible by CPS path. CPS path is described in detail in :doc:`cps-path`. For this endpoint, the ancestor of CM Handles is appended automatically so that a CM Handle is always returned. For example ``//state[@cm-handle-state='LOCKED']`` will become ``//state[@cm-handle-state='LOCKED']/ancestor::cm-handles``. The yang model for the dmi-registry can be found in :doc:`modeling` under the NCMP Modeling Section. Please note that although CM Handle additional-properties are shown in the dmi-registry yang model, these are considered private properties and cannot be used to query CM Handles. Any attempt to use the additional-properties to query will return an empty array.
 147
 148 .. code-block:: json
 149
 150     {
 151       "cmHandleQueryParameters": [
 152         {
 153           "conditionName": "cmHandleWithCpsPath",
 154           "conditionParameters": [
 155             {
 156               "cpsPath": "//state[@cm-handle-state='LOCKED']"
 157             }
 158           ]
 159         }
 160       ]
 161     }