fix(business data api): fix wrong BDM operation responses (#230)

Author: educhastenier

openapi/components/schemas/BusinessDataCreationResult.yaml

@@ -3,6 +3,15 @@ description: |
   An object containing: 
   * the ID of the newly created Business Data, under the name of "newBusinessDataId"
   * any unknown fields, provided as an array of names, under the name of "unknownFields"
+properties:
+  newBusinessDataId:
+    description: ID of the newly created Business Data
+    type: number
+  unknownFields:
+    description: list of unknown input fields that are not declared in the Business Data type
+    items:
+      type: string
+    type: array
 example:
   "newBusinessDataId": 1988
   "unknownFields" : [ "notAValidField" ]

openapi/components/schemas/BusinessDataImportResult.yaml

@@ -0,0 +1,19 @@
+type: object
+description: |
+  An object containing: 
+  * the list of IDs of all the newly created Business Data, under the name of "createdIds"
+  * the list of unknown fields, provided as an array of names, under the name of "unknownFields"
+properties:
+  createdIds:
+    description: List of IDs of the newly created Business Data
+    items:
+      type: number
+    type: array
+  unknownFields:
+    description: list of unknown input fields that are not declared in the Business Data type
+    items:
+      type: string
+    type: array
+example:
+  createdIds: [198, 199]
+  unknownFields: [ "department" ]

openapi/components/schemas/BusinessDataUpdateResult.yaml

@@ -0,0 +1,12 @@
+type: object
+description: |
+  An object containing: 
+  * any unknown fields, provided as an array of names, under the name of "unknownFields"
+properties:
+  unknownFields:
+    description: list of unknown input fields that are not declared in the Business Data type
+    items:
+      type: string
+    type: array
+example:
+  unknownFields : [ "notAValidField" ]

openapi/paths/API@bdm@businessData@{businessDataType}@import.yaml

@@ -49,14 +49,7 @@ post:
       content:
         application/json:
           schema:
-            type: object
-            description: |
-              An object containing: 
-              * the list of IDs of all the newly created Business Data, under the name of "createdIds"
-              * the list of unknown fields, provided as an array of names, under the name of "unknownFields"
-            example:
-              createdIds: [198, 199]
-              unknownFields: [ "department" ]
+            $ref: '../components/schemas/BusinessDataImportResult.yaml'
 
     '401':
       $ref: '../components/responses/Unauthorized.yaml'

openapi/paths/API@bdm@businessData@{businessDataType}@{persistenceId}.yaml

@@ -21,7 +21,9 @@ get:
       name: persistenceId
       required: true
       schema:
-        type: number
+        type: string
+        maxLength: 250
+        pattern: '^[A-Za-z0-9\_\-\.]{0,250}$'
       example: 1
   responses:
     '200':
@@ -88,11 +90,7 @@ put:
       content:
         application/json:
           schema:
-            type: object
-            description: |
-              The list of unknown fields passed as inputs, provided as an array of names, under the name of "unknownFields"
-            example:
-              unknownFields: [ "notAValidField" ]
+            $ref: '../components/schemas/BusinessDataUpdateResult.yaml'
     '401':
       $ref: '../components/responses/Unauthorized.yaml'
     '403':