Updated openapi.yaml to match to changes in get data node API

[cps.git] / cps-rest / docs / openapi / cpsData.yml

diff --git a/cps-rest/docs/openapi/cpsData.yml b/cps-rest/docs/openapi/cpsData.yml
index 15f8a1c..265ee23 100644 (file)
--- a/cps-rest/docs/openapi/cpsData.yml
+++ b/cps-rest/docs/openapi/cpsData.yml
@@ -1,5 +1,6 @@
 # ============LICENSE_START=======================================================
-# Copyright (c) 2021 Bell Canada.
+# Copyright (c) 2021-2022 Bell Canada.
+# Modifications Copyright (C) 2021-2022 Nordix Foundation
 # ================================================================================
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -36,16 +37,16 @@ nodeByDataspaceAndAnchor:
             schema:
               type: object
             examples:
-              dataSampleResponse:
-                $ref: 'components.yml#/components/examples/dataSampleResponse'
+              dataSample:
+                $ref: 'components.yml#/components/examples/dataSample'
       '400':
         $ref: 'components.yml#/components/responses/BadRequest'
       '401':
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
-      '404':
-        $ref: 'components.yml#/components/responses/NotFound'
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'
     x-codegen-request-body-name: xpath
 
 listElementByDataspaceAndAnchor:
@@ -67,8 +68,8 @@ listElementByDataspaceAndAnchor:
           schema:
             type: object
           examples:
-            dataSampleRequest:
-              $ref: 'components.yml#/components/examples/dataSampleRequest'
+            dataSample:
+              $ref: 'components.yml#/components/examples/dataSample'
     responses:
       '201':
         $ref: 'components.yml#/components/responses/Created'
@@ -78,7 +79,8 @@ listElementByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
-
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'
   put:
     description: Replace list content under a given parent, anchor and dataspace
     tags:
@@ -97,8 +99,8 @@ listElementByDataspaceAndAnchor:
           schema:
             type: object
           examples:
-            dataSampleRequest:
-              $ref: 'components.yml#/components/examples/dataSampleRequest'
+            dataSample:
+              $ref: 'components.yml#/components/examples/dataSample'
     responses:
       '200':
         $ref: 'components.yml#/components/responses/Ok'
@@ -108,7 +110,8 @@ listElementByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
-
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'
   delete:
     description: Delete one or all list element(s) for a given anchor and dataspace
     deprecated: true
@@ -130,6 +133,8 @@ listElementByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'
 
 nodesByDataspaceAndAnchor:
   post:
@@ -150,8 +155,8 @@ nodesByDataspaceAndAnchor:
           schema:
             type: object
           examples:
-            dataSampleRequest:
-              $ref: 'components.yml#/components/examples/dataSampleRequest'
+            dataSample:
+              $ref: 'components.yml#/components/examples/dataSample'
     responses:
       '201':
         $ref: 'components.yml#/components/responses/Created'
@@ -161,7 +166,10 @@ nodesByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
-
+      '409':
+        $ref: 'components.yml#/components/responses/Conflict'
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'
   patch:
     description: Update a data node leaves for a given dataspace and anchor and a parent node xpath
     tags:
@@ -180,8 +188,8 @@ nodesByDataspaceAndAnchor:
           schema:
             type: object
           examples:
-            dataSampleRequest:
-              $ref: 'components.yml#/components/examples/dataSampleRequest'
+            dataSample:
+              $ref: 'components.yml#/components/examples/dataSample'
     responses:
       '200':
         $ref: 'components.yml#/components/responses/Ok'
@@ -191,7 +199,8 @@ nodesByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
-
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'
   delete:
     description: Delete a datanode for a given dataspace and anchor given a node xpath.
     tags:
@@ -212,8 +221,8 @@ nodesByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
-
-
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'
   put:
     description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath
     tags:
@@ -232,8 +241,8 @@ nodesByDataspaceAndAnchor:
           schema:
             type: object
           examples:
-            dataSampleRequest:
-              $ref: 'components.yml#/components/examples/dataSampleRequest'
+            dataSample:
+              $ref: 'components.yml#/components/examples/dataSample'
     responses:
       '200':
         $ref: 'components.yml#/components/responses/Ok'
@@ -243,3 +252,5 @@ nodesByDataspaceAndAnchor:
         $ref: 'components.yml#/components/responses/Unauthorized'
       '403':
         $ref: 'components.yml#/components/responses/Forbidden'
+      '500':
+        $ref: 'components.yml#/components/responses/InternalServerError'