Skip to content

Commit 85da9b2

Browse files
author
Pedro Crespo
committed
Modifies director API specs. Implementation expected in ITISFoundation#363
1 parent dad2661 commit 85da9b2

File tree

2 files changed

+24
-7
lines changed

2 files changed

+24
-7
lines changed

api/specs/director/v0/openapi.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ paths:
7272
content:
7373
application/json:
7474
schema:
75-
$ref: '../../shared/schemas/services.yaml#/components/schemas/ServicesEnveloped'
75+
$ref: '../../shared/schemas/services.yaml#/components/schemas/ServicesEnveloped'
7676
"401":
7777
description: Unauthorized access
7878
content:
@@ -102,7 +102,7 @@ paths:
102102
content:
103103
application/json:
104104
schema:
105-
$ref: '../../shared/schemas/services.yaml#/components/schemas/ServicesEnveloped'
105+
$ref: '../../shared/schemas/services.yaml#/components/schemas/ServicesEnveloped'
106106
"401":
107107
description: Unauthorized access
108108
content:
@@ -129,7 +129,7 @@ paths:
129129
summary: Starts an interactive service in the oSparc platform and returns its entrypoint
130130
description: Starts an interactive service in the oSparc platform and returns its entrypoint
131131
operationId: running_interactive_services_post
132-
parameters:
132+
parameters:
133133
- $ref: '#/components/parameters/UserId'
134134
- $ref: '#/components/parameters/ServiceKey'
135135
- $ref: '#/components/parameters/ServiceVersion'
@@ -182,12 +182,12 @@ paths:
182182
parameters:
183183
- $ref: '#/components/parameters/ServiceUuid'
184184
responses:
185-
"204":
186-
description: OK service exists and runs
185+
"200":
186+
description: "Services exists and runs. Returns enpoint of running service"
187187
content:
188188
application/json:
189189
schema:
190-
$ref: '../../shared/schemas/response204.yaml#/components/schemas/Response204Enveloped'
190+
$ref: '../../shared/schemas/running_service.yaml#/components/schemas/RunningServiceEnveloped'
191191
"400":
192192
description: Malformed function call, missing field
193193
content:

api/specs/shared/schemas/running_service.yaml

+18-1
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ components:
1010
error:
1111
nullable: true
1212
default: null
13-
13+
1414
RunningServiceType:
1515
type: object
1616
required:
1717
- published_port
1818
- service_uuid
19+
- service_key
20+
- service_version
1921
properties:
2022
published_port:
2123
description: The ports where the service provides its interface
@@ -32,3 +34,18 @@ components:
3234
type: string
3335
format: UUID
3436
example: 123e4567-e89b-12d3-a456-426655440000
37+
service_key:
38+
type: string
39+
description: distinctive name for the node based on the docker registry path
40+
pattern: '^(simcore)/(services)/(comp|dynamic)(/[^\s/]+)+$'
41+
example:
42+
- simcore/services/comp/itis/sleeper
43+
- simcore/services/dynamic/3dviewer
44+
service_version:
45+
type: string
46+
description: semantic version number
47+
pattern: >-
48+
^(0|[1-9]\d*)(\.(0|[1-9]\d*)){2}(-(0|[1-9]\d*|\d*[-a-zA-Z][-\da-zA-Z]*)(\.(0|[1-9]\d*|\d*[-a-zA-Z][-\da-zA-Z]*))*)?(\+[-\da-zA-Z]+(\.[-\da-zA-Z-]+)*)?$
49+
example:
50+
- 1.0.0
51+
- 0.0.1

0 commit comments

Comments
 (0)