update endpoints to assert usability in both json and yaml

Author: Leopold-Cramer

dataset/src/main/openapi/dataset.yaml

@@ -42,8 +42,7 @@ paths:
                 $ref: '#/components/examples/BreweryADT'
           application/yaml:
             schema:
-              type: string
-              format: binary
+              $ref: '#/components/schemas/Dataset'
             examples:
               BreweryADT:
                 $ref: '#/components/examples/BreweryADT'
@@ -131,8 +130,7 @@ paths:
                 $ref: '#/components/examples/DatasetSearch'
           application/yaml:
             schema:
-              type: string
-              format: binary
+              $ref: '#/components/schemas/DatasetSearch'
             examples:
               DatasetSearch:
                 $ref: '#/components/examples/DatasetSearch'
@@ -174,8 +172,7 @@ paths:
                 $ref: '#/components/examples/BreweryDatasetCopyParameters'
           application/yaml:
             schema:
-              type: string
-              format: binary
+              $ref: '#/components/schemas/DatasetCopyParameters'
             examples:
               BreweryDatasetCopyParameters:
                 $ref: '#/components/examples/BreweryDatasetCopyParameters'
@@ -230,7 +227,11 @@ paths:
         - dataset
       summary: Update a dataset
       requestBody:
-        description: the new Dataset details. This endpoint can't be used to update security
+        description: |
+          The new Dataset details.
+          This endpoint can't be used to update :
+            - id
+            - security
         required: true
         content:
           application/json:
@@ -241,8 +242,7 @@ paths:
                 $ref: '#/components/examples/BreweryADTUpdate'
           application/yaml:
             schema:
-              type: string
-              format: binary
+              $ref: '#/components/schemas/Dataset'
             examples:
               BreweryADTUpdate:
                 $ref: '#/components/examples/BreweryADTUpdate'
@@ -350,6 +350,12 @@ paths:
             examples:
               BreweryADT:
                 $ref: '#/components/examples/BreweryADT'
+          application/yaml:
+            schema:
+              $ref: '#/components/schemas/SubDatasetGraphQuery'
+            examples:
+              BreweryADT:
+                $ref: '#/components/examples/BreweryADT'
       responses:
         '200':
           description: Successful response
@@ -464,6 +470,12 @@ paths:
             examples:
               GetAllNodes:
                 $ref: '#/components/examples/TwinGraphGetAllNodes'
+          application/yaml:
+            schema:
+              $ref: '#/components/schemas/DatasetTwinGraphQuery'
+            examples:
+              GetAllNodes:
+                $ref: '#/components/examples/TwinGraphGetAllNodes'
       responses:
         '200':
           description: Successful response
@@ -517,6 +529,14 @@ paths:
             examples:
               QueryEntities:
                 $ref: '#/components/examples/QueryEntities'
+          application/yaml:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/GraphProperties'
+            examples:
+              QueryEntities:
+                $ref: '#/components/examples/QueryEntities'
       responses:
         '200':
           description: Successful response
@@ -568,6 +588,14 @@ paths:
             examples:
               QueryEntities:
                 $ref: '#/components/examples/QueryEntities'
+          application/yaml:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/GraphProperties'
+            examples:
+              QueryEntities:
+                $ref: '#/components/examples/QueryEntities'
       responses:
         '200':
           description: Successful response
@@ -647,7 +675,7 @@ paths:
       operationId: twingraphBatchUpdate
       tags:
         - dataset
-      summary: "Async batch update by loading a CSV file on a graph instance "
+      summary: Async batch update by loading a CSV file on a graph instance
       description: |
         Async batch update by loading a CSV file on a graph instance 
         Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
@@ -916,8 +944,7 @@ paths:
                 $ref: '#/components/examples/BreweryDatasetRole'
           application/yaml:
             schema:
-              type: string
-              format: binary
+              $ref: '#/components/schemas/DatasetRole'
             examples:
               BreweryDatasetRole:
                 $ref: '#/components/examples/BreweryDatasetRole'
@@ -961,8 +988,7 @@ paths:
                 $ref: '#/components/examples/BreweryDatasetAccessControl'
           application/yaml:
             schema:
-              type: string
-              format: binary
+              $ref: '#/components/schemas/DatasetAccessControl'
             examples:
               DatasetAccess:
                 $ref: '#/components/examples/BreweryDatasetAccessControl'

doc/Apis/DatasetApi.md

@@ -28,7 +28,7 @@ All URIs are relative to *https://dev.api.cosmotech.com*
 | [**searchDatasets**](DatasetApi.md#searchDatasets) | **POST** /organizations/{organization_id}/datasets/search | Search Datasets by tags |
 | [**setDatasetDefaultSecurity**](DatasetApi.md#setDatasetDefaultSecurity) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/security/default | Set the Dataset default security |
 | [**twingraphBatchQuery**](DatasetApi.md#twingraphBatchQuery) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/batch-query | Run a query on a graph instance and return the result as a zip file in async mode |
-| [**twingraphBatchUpdate**](DatasetApi.md#twingraphBatchUpdate) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/batch | Async batch update by loading a CSV file on a graph instance  |
+| [**twingraphBatchUpdate**](DatasetApi.md#twingraphBatchUpdate) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/batch | Async batch update by loading a CSV file on a graph instance |
 | [**twingraphQuery**](DatasetApi.md#twingraphQuery) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/twingraph | Return the result of a query made on the graph instance as a json |
 | [**unlinkWorkspace**](DatasetApi.md#unlinkWorkspace) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/unlink |  |
 | [**updateDataset**](DatasetApi.md#updateDataset) | **PATCH** /organizations/{organization_id}/datasets/{dataset_id} | Update a dataset |
@@ -171,7 +171,7 @@ Create a sub-dataset from the dataset in parameter
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="createTwingraphEntities"></a>
@@ -201,7 +201,7 @@ Create new entities in a graph instance
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="deleteDataset"></a>
@@ -702,7 +702,7 @@ Run a query on a graph instance and return the result as a zip file in async mod
 # **twingraphBatchUpdate**
 > TwinGraphBatchResult twingraphBatchUpdate(organization\_id, dataset\_id, twinGraphQuery, body)
 
-Async batch update by loading a CSV file on a graph instance 
+Async batch update by loading a CSV file on a graph instance
 
     Async batch update by loading a CSV file on a graph instance  Note: This endpoint is activated only if &#x60;csm.platform.twincache.useGraphModule&#x60; property is set to true 
 
@@ -754,7 +754,7 @@ Return the result of a query made on the graph instance as a json
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="unlinkWorkspace"></a>
@@ -796,7 +796,7 @@ Update a dataset
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **dataset\_id** | **String**| the Dataset identifier | [default to null] |
-| **Dataset** | [**Dataset**](../Models/Dataset.md)| the new Dataset details. This endpoint can&#39;t be used to update security | |
+| **Dataset** | [**Dataset**](../Models/Dataset.md)| The new Dataset details. This endpoint can&#39;t be used to update :   - id   - security  | |
 
 ### Return type
 
@@ -866,7 +866,7 @@ Update entities in a graph instance
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="uploadTwingraph"></a>

doc/Apis/OrganizationApi.md

@@ -337,7 +337,7 @@ Update an Organization
 |Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
-| **Organization** | [**Organization**](../Models/Organization.md)| the new Organization details. This endpoint can't be used to update security | |
+| **Organization** | [**Organization**](../Models/Organization.md)| The new Organization details. This endpoint can't be used to update :   - id   - ownerId   - security  | |
 
 ### Return type
 
@@ -376,7 +376,7 @@ Update the specified access to User for an Organization
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="updateSolutionsContainerRegistryByOrganizationId"></a>
@@ -454,6 +454,6 @@ Update tenant credentials for the Organization specified
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+- **Content-Type**: application/json, application/yaml
+- **Accept**: application/json, application/yaml
 

doc/Apis/RunApi.md

@@ -180,7 +180,7 @@ query the run data
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="sendRunData"></a>
@@ -209,6 +209,6 @@ Send data associated to a run
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 

doc/Apis/RunnerApi.md

@@ -391,7 +391,7 @@ Update a runner
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **workspace\_id** | **String**| the Workspace identifier | [default to null] |
 | **runner\_id** | **String**| the Runner identifier | [default to null] |
-| **Runner** | [**Runner**](../Models/Runner.md)| the new Runner details. This endpoint can't be used to update ':' - id - ownerId - organizationId - workspaceId - creationDate - security | |
+| **Runner** | [**Runner**](../Models/Runner.md)| The new Runner details. This endpoint can't be used to update :   - id    - ownerId   - organizationId   - workspaceId   - creationDate   - security  | |
 
 ### Return type
 
@@ -432,6 +432,6 @@ Update the specified access to User for a Runner
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 

doc/Apis/ScenarioApi.md

@@ -53,7 +53,7 @@ Add (or replace) Parameter Values for the Scenario specified
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="addScenarioAccessControl"></a>
@@ -590,7 +590,7 @@ Update a scenario
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **workspace\_id** | **String**| the Workspace identifier | [default to null] |
 | **scenario\_id** | **String**| the Scenario identifier | [default to null] |
-| **Scenario** | [**Scenario**](../Models/Scenario.md)| the new Scenario details. This endpoint can&#39;t be used to update &#39;:&#39; - id - ownerId - datasetList - solutionId - runTemplateId - parametersValues - security | |
+| **Scenario** | [**Scenario**](../Models/Scenario.md)| The new Scenario details. This endpoint can&#39;t be used to update :   - id   - ownerId   - datasetList   - solutionId   - runTemplateId   - parametersValues   - security  | |
 
 ### Return type
 
@@ -631,6 +631,6 @@ Update the specified access to User for a Scenario
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 

doc/Apis/SolutionApi.md

@@ -52,7 +52,7 @@ Add Parameter Groups. Any item with the same ID will be overwritten
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="addOrReplaceParameters"></a>
@@ -79,7 +79,7 @@ Add Parameters. Any item with the same ID will be overwritten
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="addOrReplaceRunTemplates"></a>
@@ -106,7 +106,7 @@ Add Run Templates. Any item with the same ID will be overwritten
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="addSolutionAccessControl"></a>
@@ -519,7 +519,7 @@ Update a solution
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **solution\_id** | **String**| the Solution identifier | [default to null] |
-| **Solution** | [**Solution**](../Models/Solution.md)| the new Solution details. This endpoint can&#39;t be used to update &#39;:&#39; - id - runTemplates - security | |
+| **Solution** | [**Solution**](../Models/Solution.md)| the new Solution details. This endpoint can&#39;t be used to update :   - id   - runTemplates   - security  | |
 
 ### Return type
 
@@ -559,7 +559,7 @@ Update the specified access to User for a Solution
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="updateSolutionRunTemplate"></a>

doc/Apis/WorkspaceApi.md

@@ -518,7 +518,7 @@ Update a workspace
 |------------- | ------------- | ------------- | -------------|
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **workspace\_id** | **String**| the Workspace identifier | [default to null] |
-| **Workspace** | [**Workspace**](../Models/Workspace.md)| The new Workspace details. This endpoint can't be used to update ':' - id - ownerId - security | |
+| **Workspace** | [**Workspace**](../Models/Workspace.md)| The new Workspace details. This endpoint can't be used to update :   - id   - ownerId   - security  | |
 
 ### Return type
 
@@ -558,7 +558,7 @@ Update the specified access to User for a Workspace
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/yaml
 - **Accept**: application/json
 
 <a name="uploadWorkspaceFile"></a>

doc/README.md

@@ -36,7 +36,7 @@ All URIs are relative to *https://dev.api.cosmotech.com*
 *DatasetApi* | [**searchDatasets**](Apis/DatasetApi.md#searchdatasets) | **POST** /organizations/{organization_id}/datasets/search | Search Datasets by tags |
 *DatasetApi* | [**setDatasetDefaultSecurity**](Apis/DatasetApi.md#setdatasetdefaultsecurity) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/security/default | Set the Dataset default security |
 *DatasetApi* | [**twingraphBatchQuery**](Apis/DatasetApi.md#twingraphbatchquery) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/batch-query | Run a query on a graph instance and return the result as a zip file in async mode |
-*DatasetApi* | [**twingraphBatchUpdate**](Apis/DatasetApi.md#twingraphbatchupdate) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/batch | Async batch update by loading a CSV file on a graph instance  |
+*DatasetApi* | [**twingraphBatchUpdate**](Apis/DatasetApi.md#twingraphbatchupdate) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/batch | Async batch update by loading a CSV file on a graph instance |
 *DatasetApi* | [**twingraphQuery**](Apis/DatasetApi.md#twingraphquery) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/twingraph | Return the result of a query made on the graph instance as a json |
 *DatasetApi* | [**unlinkWorkspace**](Apis/DatasetApi.md#unlinkworkspace) | **POST** /organizations/{organization_id}/datasets/{dataset_id}/unlink |  |
 *DatasetApi* | [**updateDataset**](Apis/DatasetApi.md#updatedataset) | **PATCH** /organizations/{organization_id}/datasets/{dataset_id} | Update a dataset |