|
1 | | -components: |
2 | | - schemas: |
3 | | - RunningServicesEnveloped: |
4 | | - type: object |
5 | | - required: |
6 | | - - data |
7 | | - properties: |
8 | | - data: |
9 | | - $ref: "#/components/schemas/RunningServicesArray" |
10 | | - error: |
11 | | - nullable: true |
12 | | - default: null |
13 | | - |
14 | | - RunningServicesArray: |
15 | | - type: array |
16 | | - items: |
17 | | - $ref: "#/components/schemas/RunningServiceType" |
18 | | - |
19 | | - RunningServiceEnveloped: |
20 | | - type: object |
21 | | - required: |
22 | | - - data |
23 | | - properties: |
24 | | - data: |
25 | | - $ref: "#/components/schemas/RunningServiceType" |
26 | | - error: |
27 | | - nullable: true |
28 | | - default: null |
29 | | - |
30 | | - RunningServiceType: |
31 | | - type: object |
32 | | - required: |
33 | | - - published_port |
34 | | - - service_uuid |
35 | | - - service_key |
36 | | - - service_version |
37 | | - - service_host |
38 | | - - service_port |
39 | | - - service_state |
40 | | - - user_id |
41 | | - properties: |
42 | | - published_port: |
43 | | - description: The ports where the service provides its interface |
44 | | - type: integer |
45 | | - format: int32 |
46 | | - minimum: 1 |
47 | | - example: 30000 |
48 | | - entry_point: |
49 | | - description: The entry point where the service provides its interface if specified |
50 | | - type: string |
51 | | - example: /the/entry/point/is/here |
52 | | - service_uuid: |
53 | | - description: The UUID attached to this service |
54 | | - type: string |
55 | | - # format: UUID |
56 | | - example: 123e4567-e89b-12d3-a456-426655440000 |
57 | | - service_key: |
58 | | - type: string |
59 | | - description: distinctive name for the node based on the docker registry path |
60 | | - pattern: '^(simcore)/(services)/(comp|dynamic)(/[\w/-]+)+$' |
61 | | - example: |
62 | | - - simcore/services/comp/itis/sleeper |
63 | | - - simcore/services/dynamic/3dviewer |
64 | | - service_version: |
65 | | - type: string |
66 | | - description: semantic version number |
67 | | - pattern: >- |
68 | | - ^(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-]+)*)?$ |
69 | | - example: |
70 | | - - 1.0.0 |
71 | | - - 0.0.1 |
72 | | - service_host: |
73 | | - description: service host name within the network |
74 | | - type: string |
75 | | - example: jupyter_E1O2E-LAH |
76 | | - service_port: |
77 | | - description: port to access the service within the network |
78 | | - type: integer |
79 | | - minimum: 1 |
80 | | - example: 8081 |
81 | | - service_basepath: |
82 | | - description: different base path where current service is mounted otherwise defaults to root |
83 | | - type: string |
84 | | - example: "/x/E1O2E-LAH" |
85 | | - default: "" |
86 | | - service_state: |
87 | | - description: > |
88 | | - the service state |
89 | | - * 'pending' - The service is waiting for resources to start |
90 | | - * 'pulling' - The service is being pulled from the registry |
91 | | - * 'starting' - The service is starting |
92 | | - * 'running' - The service is running |
93 | | - * 'complete' - The service completed |
94 | | - * 'failed' - The service failed to start |
95 | | - type: string |
96 | | - enum: |
97 | | - - pending |
98 | | - - pulling |
99 | | - - starting |
100 | | - - running |
101 | | - - complete |
102 | | - - failed |
103 | | - service_message: |
104 | | - description: >- |
105 | | - the service message |
106 | | - type: string |
107 | | - example: no suitable node (insufficient resources on 1 node) |
108 | | - user_id: |
109 | | - description: >- |
110 | | - the user that started the service |
111 | | - type: string |
112 | | - example: "123" |
| 1 | +components: |
| 2 | + schemas: |
| 3 | + RunningServicesEnveloped: |
| 4 | + type: object |
| 5 | + required: |
| 6 | + - data |
| 7 | + properties: |
| 8 | + data: |
| 9 | + $ref: "#/components/schemas/RunningServicesArray" |
| 10 | + error: |
| 11 | + nullable: true |
| 12 | + default: null |
| 13 | + |
| 14 | + RunningServicesArray: |
| 15 | + type: array |
| 16 | + items: |
| 17 | + $ref: "#/components/schemas/RunningServiceType" |
| 18 | + |
| 19 | + RunningServiceEnveloped: |
| 20 | + type: object |
| 21 | + required: |
| 22 | + - data |
| 23 | + properties: |
| 24 | + data: |
| 25 | + $ref: "#/components/schemas/RunningServiceType" |
| 26 | + error: |
| 27 | + nullable: true |
| 28 | + default: null |
| 29 | + |
| 30 | + RunningServiceType: |
| 31 | + type: object |
| 32 | + required: |
| 33 | + - published_port |
| 34 | + - service_uuid |
| 35 | + - service_key |
| 36 | + - service_version |
| 37 | + - service_host |
| 38 | + - service_port |
| 39 | + - service_state |
| 40 | + - user_id |
| 41 | + properties: |
| 42 | + published_port: |
| 43 | + description: The ports where the service provides its interface |
| 44 | + type: integer |
| 45 | + format: int32 |
| 46 | + minimum: 1 |
| 47 | + example: 30000 |
| 48 | + entry_point: |
| 49 | + description: The entry point where the service provides its interface if specified |
| 50 | + type: string |
| 51 | + example: /the/entry/point/is/here |
| 52 | + service_uuid: |
| 53 | + description: The UUID attached to this service |
| 54 | + type: string |
| 55 | + # format: UUID |
| 56 | + example: 123e4567-e89b-12d3-a456-426655440000 |
| 57 | + service_key: |
| 58 | + type: string |
| 59 | + description: distinctive name for the node based on the docker registry path |
| 60 | + pattern: '^(simcore)/(services)/(comp|dynamic)(/[\w/-]+)+$' |
| 61 | + example: |
| 62 | + - simcore/services/comp/itis/sleeper |
| 63 | + - simcore/services/dynamic/3dviewer |
| 64 | + service_version: |
| 65 | + type: string |
| 66 | + description: semantic version number |
| 67 | + pattern: >- |
| 68 | + ^(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-]+)*)?$ |
| 69 | + example: |
| 70 | + - 1.0.0 |
| 71 | + - 0.0.1 |
| 72 | + service_host: |
| 73 | + description: service host name within the network |
| 74 | + type: string |
| 75 | + example: jupyter_E1O2E-LAH |
| 76 | + service_port: |
| 77 | + description: port to access the service within the network |
| 78 | + type: integer |
| 79 | + minimum: 1 |
| 80 | + example: 8081 |
| 81 | + service_basepath: |
| 82 | + description: different base path where current service is mounted otherwise defaults to root |
| 83 | + type: string |
| 84 | + example: "/x/E1O2E-LAH" |
| 85 | + default: "" |
| 86 | + service_state: |
| 87 | + description: > |
| 88 | + the service state |
| 89 | + * 'pending' - The service is waiting for resources to start |
| 90 | + * 'pulling' - The service is being pulled from the registry |
| 91 | + * 'starting' - The service is starting |
| 92 | + * 'running' - The service is running |
| 93 | + * 'complete' - The service completed |
| 94 | + * 'failed' - The service failed to start |
| 95 | + type: string |
| 96 | + enum: |
| 97 | + - pending |
| 98 | + - pulling |
| 99 | + - starting |
| 100 | + - running |
| 101 | + - complete |
| 102 | + - failed |
| 103 | + service_message: |
| 104 | + description: >- |
| 105 | + the service message |
| 106 | + type: string |
| 107 | + example: no suitable node (insufficient resources on 1 node) |
| 108 | + user_id: |
| 109 | + description: >- |
| 110 | + the user that started the service |
| 111 | + type: string |
| 112 | + example: "123" |
0 commit comments