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     responses:
  37       200:
  38         $ref: 'components.yaml#/components/responses/Ok'
  39       400:
  40         $ref: 'components.yaml#/components/responses/BadRequest'
  41       401:
  42         $ref: 'components.yaml#/components/responses/Unauthorized'
  43       403:
  44         $ref: 'components.yaml#/components/responses/Forbidden'
  45       404:
  46         $ref: 'components.yaml#/components/responses/NotFound'
  47
  48 nodesByCmHandleAndXpath:
  49   patch:
  50     description: Update node leaves for the given cps path and cm Handle
  51     tags:
  52       - nf-proxy
  53     summary: Update node leaves
  54     operationId: updateNodeLeaves
  55     parameters:
  56       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
  57       - $ref: 'components.yaml#/components/parameters/xpathInQuery'
  58     requestBody:
  59       required: true
  60       content:
  61         application/json:
  62           schema:
  63             type: string
  64     responses:
  65       200:
  66         $ref: 'components.yaml#/components/responses/Ok'
  67       400:
  68         $ref: 'components.yaml#/components/responses/BadRequest'
  69       401:
  70         $ref: 'components.yaml#/components/responses/Unauthorized'
  71       403:
  72         $ref: 'components.yaml#/components/responses/Forbidden'
  73       404:
  74         $ref: 'components.yaml#/components/responses/NotFound'
  75
  76   put:
  77     description: Replace a node with descendants for the given cps path and cm Handle
  78     tags:
  79       - nf-proxy
  80     summary: Replace a node with descendants
  81     operationId: replaceNode
  82     parameters:
  83       - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
  84       - $ref: 'components.yaml#/components/parameters/xpathInQuery'
  85     requestBody:
  86       required: true
  87       content:
  88         application/json:
  89           schema:
  90             type: string
  91     responses:
  92       200:
  93         $ref: 'components.yaml#/components/responses/Ok'
  94       400:
  95         $ref: 'components.yaml#/components/responses/BadRequest'
  96       401:
  97         $ref: 'components.yaml#/components/responses/Unauthorized'
  98       403:
  99         $ref: 'components.yaml#/components/responses/Forbidden'
 100       404:
 101         $ref: 'components.yaml#/components/responses/NotFound'