Skip to content

Commit 08f5b96

Browse files
committed
updated openapi
1 parent 9736475 commit 08f5b96

File tree

1 file changed

+115
-22
lines changed
  • services/web/server/src/simcore_service_webserver/api/v0

1 file changed

+115
-22
lines changed

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

Lines changed: 115 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2368,7 +2368,7 @@ paths:
23682368
content:
23692369
application/json:
23702370
schema:
2371-
$ref: '#/components/schemas/Envelope_ComputationTaskGet_'
2371+
$ref: '#/components/schemas/Envelope_ComputationGet_'
23722372
/v0/computations/{project_id}:start:
23732373
post:
23742374
tags:
@@ -4391,7 +4391,7 @@ paths:
43914391
'403':
43924392
description: ProjectInvalidRightsError
43934393
'404':
4394-
description: ProjectNotFoundError, UserDefaultWalletNotFoundError
4394+
description: UserDefaultWalletNotFoundError, ProjectNotFoundError
43954395
'409':
43964396
description: ProjectTooManyProjectOpenedError
43974397
'422':
@@ -7088,17 +7088,89 @@ components:
70887088
required:
70897089
- version
70907090
title: CompatibleService
7091+
ComputationGet:
7092+
properties:
7093+
id:
7094+
type: string
7095+
format: uuid
7096+
title: Id
7097+
description: the id of the computation task
7098+
state:
7099+
$ref: '#/components/schemas/RunningState'
7100+
description: the state of the computational task
7101+
result:
7102+
anyOf:
7103+
- type: string
7104+
- type: 'null'
7105+
title: Result
7106+
description: the result of the computational task
7107+
pipeline_details:
7108+
$ref: '#/components/schemas/PipelineDetails'
7109+
description: the details of the generated pipeline
7110+
iteration:
7111+
anyOf:
7112+
- type: integer
7113+
exclusiveMinimum: true
7114+
minimum: 0
7115+
- type: 'null'
7116+
title: Iteration
7117+
description: the iteration id of the computation task (none if no task ran
7118+
yet)
7119+
started:
7120+
anyOf:
7121+
- type: string
7122+
format: date-time
7123+
- type: 'null'
7124+
title: Started
7125+
description: the timestamp when the computation was started or None if not
7126+
started yet
7127+
stopped:
7128+
anyOf:
7129+
- type: string
7130+
format: date-time
7131+
- type: 'null'
7132+
title: Stopped
7133+
description: the timestamp when the computation was stopped or None if not
7134+
started nor stopped yet
7135+
submitted:
7136+
anyOf:
7137+
- type: string
7138+
format: date-time
7139+
- type: 'null'
7140+
title: Submitted
7141+
description: task last modification timestamp or None if the there is no
7142+
task
7143+
url:
7144+
type: string
7145+
minLength: 1
7146+
format: uri
7147+
title: Url
7148+
description: the link where to get the status of the task
7149+
stop_url:
7150+
anyOf:
7151+
- type: string
7152+
minLength: 1
7153+
format: uri
7154+
- type: 'null'
7155+
title: Stop Url
7156+
description: the link where to stop the task
7157+
type: object
7158+
required:
7159+
- id
7160+
- state
7161+
- pipeline_details
7162+
- iteration
7163+
- started
7164+
- stopped
7165+
- submitted
7166+
- url
7167+
title: ComputationGet
70917168
ComputationStart:
70927169
properties:
70937170
force_restart:
70947171
type: boolean
70957172
title: Force Restart
70967173
default: false
7097-
cluster_id:
7098-
type: integer
7099-
minimum: 0
7100-
title: Cluster Id
7101-
default: 0
71027174
subgraph:
71037175
items:
71047176
type: string
@@ -7108,18 +7180,6 @@ components:
71087180
default: []
71097181
type: object
71107182
title: ComputationStart
7111-
ComputationTaskGet:
7112-
properties:
7113-
cluster_id:
7114-
anyOf:
7115-
- type: integer
7116-
minimum: 0
7117-
- type: 'null'
7118-
title: Cluster Id
7119-
type: object
7120-
required:
7121-
- cluster_id
7122-
title: ComputationTaskGet
71237183
ConnectServiceToPricingPlanBodyParams:
71247184
properties:
71257185
serviceKey:
@@ -7389,19 +7449,19 @@ components:
73897449
title: Error
73907450
type: object
73917451
title: Envelope[CheckpointApiModel]
7392-
Envelope_ComputationTaskGet_:
7452+
Envelope_ComputationGet_:
73937453
properties:
73947454
data:
73957455
anyOf:
7396-
- $ref: '#/components/schemas/ComputationTaskGet'
7456+
- $ref: '#/components/schemas/ComputationGet'
73977457
- type: 'null'
73987458
error:
73997459
anyOf:
74007460
- {}
74017461
- type: 'null'
74027462
title: Error
74037463
type: object
7404-
title: Envelope[ComputationTaskGet]
7464+
title: Envelope[ComputationGet]
74057465
Envelope_FileMetaDataGet_:
74067466
properties:
74077467
data:
@@ -10964,6 +11024,39 @@ components:
1096411024
- phone
1096511025
- code
1096611026
title: PhoneConfirmationBody
11027+
PipelineDetails:
11028+
properties:
11029+
adjacency_list:
11030+
additionalProperties:
11031+
items:
11032+
type: string
11033+
format: uuid
11034+
type: array
11035+
type: object
11036+
title: Adjacency List
11037+
description: 'The adjacency list of the current pipeline in terms of {NodeID:
11038+
[successor NodeID]}'
11039+
progress:
11040+
anyOf:
11041+
- type: number
11042+
maximum: 1.0
11043+
minimum: 0.0
11044+
- type: 'null'
11045+
title: Progress
11046+
description: the progress of the pipeline (None if there are no computational
11047+
tasks)
11048+
node_states:
11049+
additionalProperties:
11050+
$ref: '#/components/schemas/NodeState'
11051+
type: object
11052+
title: Node States
11053+
description: The states of each of the computational nodes in the pipeline
11054+
type: object
11055+
required:
11056+
- adjacency_list
11057+
- progress
11058+
- node_states
11059+
title: PipelineDetails
1096711060
PortLink:
1096811061
properties:
1096911062
nodeUuid:

0 commit comments

Comments
 (0)