cps-nf-proxy-rest/docs/openapi/xnfProxy.yml

   1 nodeByCmHandleAndXpath:
   2   get:
   3     description: Get a node with an option to retrieve all the children for a given cm Handle
   4     tags:
   5       - nf-proxy
   6     summary: Get a node given a cm Handle and xpath
   7     operationId: getNodeByCmHandleAndXpath
   8     parameters:
   9       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
  10       - $ref: 'components.yaml#/components/parameters/xpathInQuery'
  11       - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
  12     responses:
  13       200:
  14         $ref: 'components.yaml#/components/responses/Ok'
  15       400:
  16         $ref: 'components.yaml#/components/responses/BadRequest'
  17       401:
  18         $ref: 'components.yaml#/components/responses/Unauthorized'
  19       403:
  20         $ref: 'components.yaml#/components/responses/Forbidden'
  21       404:
  22         $ref: 'components.yaml#/components/responses/NotFound'
  23       501:
  24         $ref: 'components.yaml#/components/responses/NotImplemented'
  25
  26 nodesByCmHandleAndCpsPath:
  27   get:
  28     description: Query nodes for the given cps path and cm Handle
  29     tags:
  30       - nf-proxy
  31     summary: Query data nodes
  32     operationId: queryNodesByCmHandleAndCpsPath
  33     parameters:
  34       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
  35       - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
  36       - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
  37     responses:
  38       200:
  39         $ref: 'components.yaml#/components/responses/Ok'
  40       400:
  41         $ref: 'components.yaml#/components/responses/BadRequest'
  42       401:
  43         $ref: 'components.yaml#/components/responses/Unauthorized'
  44       403:
  45         $ref: 'components.yaml#/components/responses/Forbidden'
  46       404:
  47         $ref: 'components.yaml#/components/responses/NotFound'
  48
  49 nodesByCmHandleAndXpath:
  50   patch:
  51     description: Update node leaves for the given cps path and cm Handle
  52     tags:
  53       - nf-proxy
  54     summary: Update node leaves
  55     operationId: updateNodeLeaves
  56     parameters:
  57       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
  58       - $ref: 'components.yaml#/components/parameters/xpathInQuery'
  59     requestBody:
  60       required: true
  61       content:
  62         application/json:
  63           schema:
  64             type: string
  65     responses:
  66       200:
  67         $ref: 'components.yaml#/components/responses/Ok'
  68       400:
  69         $ref: 'components.yaml#/components/responses/BadRequest'
  70       401:
  71         $ref: 'components.yaml#/components/responses/Unauthorized'
  72       403:
  73         $ref: 'components.yaml#/components/responses/Forbidden'
  74       404:
  75         $ref: 'components.yaml#/components/responses/NotFound'
  76
  77   put:
  78     description: Replace a node with descendants for the given cps path and cm Handle
  79     tags:
  80       - nf-proxy
  81     summary: Replace a node with descendants
  82     operationId: replaceNode
  83     parameters:
  84       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
  85       - $ref: 'components.yaml#/components/parameters/xpathInQuery'
  86     requestBody:
  87       required: true
  88       content:
  89         application/json:
  90           schema:
  91             type: string
  92     responses:
  93       200:
  94         $ref: 'components.yaml#/components/responses/Ok'
  95       400:
  96         $ref: 'components.yaml#/components/responses/BadRequest'
  97       401:
  98         $ref: 'components.yaml#/components/responses/Unauthorized'
  99       403:
 100         $ref: 'components.yaml#/components/responses/Forbidden'
 101       404:
 102         $ref: 'components.yaml#/components/responses/NotFound'