Skip to content

Commit 0ecc6b5

Browse files
Leopold-Cramerjreynard-code
authored andcommitted
update description for update endpoints to better explains use
1 parent 8838c3b commit 0ecc6b5

File tree

8 files changed

+44
-10
lines changed

8 files changed

+44
-10
lines changed

doc/Apis/RunnerApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ Update a runner
391391
| **organization\_id** | **String**| the Organization identifier | [default to null] |
392392
| **workspace\_id** | **String**| the Workspace identifier | [default to null] |
393393
| **runner\_id** | **String**| the Runner identifier | [default to null] |
394-
| **Runner** | [**Runner**](../Models/Runner.md)| the new Runner details. This endpoint can't be used to update security | |
394+
| **Runner** | [**Runner**](../Models/Runner.md)| the new Runner details. This endpoint can't be used to update ':' - id - ownerId - organizationId - workspaceId - creationDate - security | |
395395

396396
### Return type
397397

doc/Apis/ScenarioApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ Update a scenario
590590
| **organization\_id** | **String**| the Organization identifier | [default to null] |
591591
| **workspace\_id** | **String**| the Workspace identifier | [default to null] |
592592
| **scenario\_id** | **String**| the Scenario identifier | [default to null] |
593-
| **Scenario** | [**Scenario**](../Models/Scenario.md)| the new Scenario details. This endpoint can't be used to update security | |
593+
| **Scenario** | [**Scenario**](../Models/Scenario.md)| the new Scenario details. This endpoint can't be used to update ':' - id - ownerId - datasetList - solutionId - runTemplateId - parametersValues - security | |
594594

595595
### Return type
596596

doc/Apis/SolutionApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ Update a solution
519519
|------------- | ------------- | ------------- | -------------|
520520
| **organization\_id** | **String**| the Organization identifier | [default to null] |
521521
| **solution\_id** | **String**| the Solution identifier | [default to null] |
522-
| **Solution** | [**Solution**](../Models/Solution.md)| the new Solution details. This endpoint can't be used to update security | |
522+
| **Solution** | [**Solution**](../Models/Solution.md)| the new Solution details. This endpoint can't be used to update ':' - id - runTemplates - security | |
523523

524524
### Return type
525525

doc/Apis/WorkspaceApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ Update a workspace
518518
|------------- | ------------- | ------------- | -------------|
519519
| **organization\_id** | **String**| the Organization identifier | [default to null] |
520520
| **workspace\_id** | **String**| the Workspace identifier | [default to null] |
521-
| **Workspace** | [**Workspace**](../Models/Workspace.md)| The new Workspace details. This endpoint can't be used to update security | |
521+
| **Workspace** | [**Workspace**](../Models/Workspace.md)| The new Workspace details. This endpoint can't be used to update ':' - id - ownerId - security | |
522522

523523
### Return type
524524

runner/src/main/openapi/runner.yaml

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,26 @@ openapi: 3.0.3
22

33
info:
44
title: Cosmo Tech Runner Manager API
5-
description: Cosmo Tech Runner Manager API
5+
description: |
6+
Cosmo Tech Runner Manager API
7+
8+
This API provides endpoints to manage runners for simulations and analyses.
69
version: 0.0.8-SNAPSHOT
10+
contact:
11+
name: Cosmo Tech Support
12+
url: https://support.cosmotech.com
13+
714

815
servers:
916
- url: 'https://api.azure.cosmo-platform.com'
17+
description: Production server
1018
- url: 'http://localhost:4010'
19+
description: Local development server
1120

1221
security:
13-
- oAuth2AuthCode: [ ]
22+
- oAuth2AuthCode:
23+
- platform.runner.read
24+
- platform.runner.write
1425

1526
tags:
1627
- name: runner
@@ -143,7 +154,14 @@ paths:
143154
- runner
144155
summary: Update a runner
145156
requestBody:
146-
description: the new Runner details. This endpoint can't be used to update security
157+
description: the new Runner details.
158+
This endpoint can't be used to update ':'
159+
- id
160+
- ownerId
161+
- organizationId
162+
- workspaceId
163+
- creationDate
164+
- security
147165
required: true
148166
content:
149167
application/json:

scenario/src/main/openapi/scenario.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,15 @@ paths:
240240
- scenario
241241
summary: Update a scenario
242242
requestBody:
243-
description: the new Scenario details. This endpoint can't be used to update security
243+
description: the new Scenario details.
244+
This endpoint can't be used to update ':'
245+
- id
246+
- ownerId
247+
- datasetList
248+
- solutionId
249+
- runTemplateId
250+
- parametersValues
251+
- security
244252
required: true
245253
content:
246254
application/json:

solution/src/main/openapi/solution.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,11 @@ paths:
127127
- solution
128128
summary: Update a solution
129129
requestBody:
130-
description: the new Solution details. This endpoint can't be used to update security
130+
description: the new Solution details.
131+
This endpoint can't be used to update ':'
132+
- id
133+
- runTemplates
134+
- security
131135
required: true
132136
content:
133137
application/json:

workspace/src/main/openapi/workspace.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,11 @@ paths:
126126
- workspace
127127
summary: Update a workspace
128128
requestBody:
129-
description: The new Workspace details. This endpoint can't be used to update security
129+
description: The new Workspace details.
130+
This endpoint can't be used to update ':'
131+
- id
132+
- ownerId
133+
- security
130134
required: true
131135
content:
132136
application/json:

0 commit comments

Comments
 (0)