Skip to content

Commit 10211cd

Browse files
odeimaizodeimaiz
authored
Merge pull request #10 from sanderegg/feature/#233_api_sharing
Feature/ITISFoundation#233 api sharing
2 parents ff3af8b + 89362a1 commit 10211cd

File tree

63 files changed

+1547
-1585
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+1547
-1585
lines changed

‎packages/director-sdk/codegen.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#/bin/bash
22
exec ../../scripts/openapi/openapi_codegen.sh \
3-
-i ../../services/director/src/simcore_service_director/oas3/v1/openapi.yaml \
3+
-i ../../services/director/src/simcore_service_director/oas3/v0/openapi.yaml \
44
-o . \
55
-g python \
66
-c ./codegen_config.json

‎packages/director-sdk/python/.openapi-generator/VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.3.0-SNAPSHOT
1+
3.2.3

‎packages/director-sdk/python/README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
2323

2424
Then import the package:
2525
```python
26-
import simcore_director_sdk
26+
import simcore_director_sdk
2727
```
2828

2929
### Setuptools
@@ -79,16 +79,16 @@ Class | Method | HTTP request | Description
7979

8080
## Documentation For Models
8181

82-
- [Error](docs/Error.md)
83-
- [ErrorEnveloped](docs/ErrorEnveloped.md)
84-
- [HealthCheck](docs/HealthCheck.md)
85-
- [HealthCheckEnveloped](docs/HealthCheckEnveloped.md)
86-
- [NodeMetaV0](docs/NodeMetaV0.md)
87-
- [Nodemetav0Authors](docs/Nodemetav0Authors.md)
88-
- [Response204Enveloped](docs/Response204Enveloped.md)
89-
- [RunningService](docs/RunningService.md)
90-
- [RunningServiceEnveloped](docs/RunningServiceEnveloped.md)
91-
- [ServicesEnveloped](docs/ServicesEnveloped.md)
82+
- [InlineResponse200](docs/InlineResponse200.md)
83+
- [InlineResponse2001](docs/InlineResponse2001.md)
84+
- [InlineResponse2001Authors](docs/InlineResponse2001Authors.md)
85+
- [InlineResponse200Data](docs/InlineResponse200Data.md)
86+
- [InlineResponse201](docs/InlineResponse201.md)
87+
- [InlineResponse201Data](docs/InlineResponse201Data.md)
88+
- [InlineResponse204](docs/InlineResponse204.md)
89+
- [InlineResponseDefault](docs/InlineResponseDefault.md)
90+
- [InlineResponseDefaultData](docs/InlineResponseDefaultData.md)
91+
- [SimcoreNode](docs/SimcoreNode.md)
9292

9393

9494
## Documentation For Authorization
@@ -99,3 +99,5 @@ Class | Method | HTTP request | Description
9999
## Author
100100

101101
[email protected]
102+
103+

‎packages/director-sdk/python/docs/ErrorEnveloped.md renamed to ‎packages/director-sdk/python/docs/InlineResponse200.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# ErrorEnveloped
1+
# InlineResponse200
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**data** | [**Error**](Error.md) | | [optional]
6+
**data** | [**InlineResponse200Data**](InlineResponse200Data.md) | | [optional]
77
**status** | **int** | | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎packages/director-sdk/python/docs/RunningServiceEnveloped.md renamed to ‎packages/director-sdk/python/docs/InlineResponse2001.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# RunningServiceEnveloped
1+
# InlineResponse2001
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**data** | [**RunningService**](RunningService.md) | | [optional]
6+
**data** | [**list[SimcoreNode]**](SimcoreNode.md) | | [optional]
77
**status** | **int** | | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎packages/director-sdk/python/docs/Nodemetav0Authors.md renamed to ‎packages/director-sdk/python/docs/InlineResponse2001Authors.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Nodemetav0Authors
1+
# InlineResponse2001Authors
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | Name of the author | [optional]
7-
**email** | **str** | Email address | [optional]
86
**affiliation** | **str** | Affiliation of the author | [optional]
7+
**email** | **str** | Email address | [optional]
8+
**name** | **str** | Name of the author | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

‎packages/director-sdk/python/docs/HealthCheck.md renamed to ‎packages/director-sdk/python/docs/InlineResponse200Data.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# HealthCheck
1+
# InlineResponse200Data
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**api_version** | **str** | | [optional]
67
**name** | **str** | | [optional]
78
**status** | **str** | | [optional]
8-
**api_version** | **str** | | [optional]
99
**version** | **str** | | [optional]
1010

1111
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎packages/director-sdk/python/docs/ServicesEnveloped.md renamed to ‎packages/director-sdk/python/docs/InlineResponse201.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# ServicesEnveloped
1+
# InlineResponse201
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**data** | [**list[NodeMetaV0]**](NodeMetaV0.md) | | [optional]
6+
**data** | [**InlineResponse201Data**](InlineResponse201Data.md) | | [optional]
77
**status** | **int** | | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎packages/director-sdk/python/docs/RunningService.md renamed to ‎packages/director-sdk/python/docs/InlineResponse201Data.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# RunningService
1+
# InlineResponse201Data
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**published_port** | **int** | The ports where the service provides its interface |
7-
**entry_point** | **str** | The entry point where the service provides its interface if specified | [optional]
8-
**service_uuid** | **str** | The UUID attached to this service |
6+
**entry_point** | **str** | The entry point where the service provides its interface if specified | [optional]
7+
**published_port** | **int** | The ports where the service provides its interface | [optional]
8+
**service_uuid** | **str** | The UUID attached to this service | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎packages/director-sdk/python/docs/Response204Enveloped.md renamed to ‎packages/director-sdk/python/docs/InlineResponse204.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Response204Enveloped
1+
# InlineResponse204
22

33
## Properties
44
Name | Type | Description | Notes

‎packages/director-sdk/python/docs/HealthCheckEnveloped.md renamed to ‎packages/director-sdk/python/docs/InlineResponseDefault.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# HealthCheckEnveloped
1+
# InlineResponseDefault
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**data** | [**HealthCheck**](HealthCheck.md) | | [optional]
6+
**data** | [**InlineResponseDefaultData**](InlineResponseDefaultData.md) | | [optional]
77
**status** | **int** | | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎packages/director-sdk/python/docs/Error.md renamed to ‎packages/director-sdk/python/docs/InlineResponseDefaultData.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Error
1+
# InlineResponseDefaultData
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | Error message |
76
**errors** | **list[object]** | | [optional]
8-
**status** | **int** | Error code |
7+
**message** | **str** | Error message | [optional]
8+
**status** | **int** | Error code | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

‎packages/director-sdk/python/docs/NodeMetaV0.md renamed to ‎packages/director-sdk/python/docs/SimcoreNode.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# NodeMetaV0
1+
# SimcoreNode
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**key** | **str** | distinctive name for the node based on the docker registry path |
7-
**version** | **str** | semantic version number |
8-
**type** | **str** | service type |
9-
**name** | **str** | short, human readable name for the node |
10-
**description** | **str** | human readable description of the purpose of the node |
11-
**authors** | [**list[Nodemetav0Authors]**](Nodemetav0Authors.md) | |
12-
**contact** | **str** | email to correspond to the authors about the node |
13-
**inputs** | **object** | definition of the inputs of this node |
14-
**outputs** | **object** | definition of the outputs of this node |
6+
**authors** | [**list[InlineResponse2001Authors]**](InlineResponse2001Authors.md) | | [optional]
7+
**contact** | **str** | email to correspond to the authors about the node | [optional]
8+
**description** | **str** | human readable description of the purpose of the node | [optional]
9+
**inputs** | **object** | definition of the inputs of this node | [optional]
10+
**key** | **str** | distinctive name for the node based on the docker registry path | [optional]
11+
**name** | **str** | short, human readable name for the node | [optional]
12+
**outputs** | **object** | definition of the outputs of this node | [optional]
13+
**type** | **str** | service type | [optional]
14+
**version** | **str** | semantic version number | [optional]
1515

1616
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1717

‎packages/director-sdk/python/docs/UsersApi.md

+21-20
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Method | HTTP request | Description
1313

1414

1515
# **root_get**
16-
> HealthCheckEnveloped root_get()
16+
> InlineResponse200 root_get()
1717
1818
Service health-check endpoint
1919

@@ -43,7 +43,7 @@ This endpoint does not need any parameter.
4343

4444
### Return type
4545

46-
[**HealthCheckEnveloped**](HealthCheckEnveloped.md)
46+
[**InlineResponse200**](InlineResponse200.md)
4747

4848
### Authorization
4949

@@ -57,7 +57,7 @@ No authorization required
5757
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
5858

5959
# **running_interactive_services_delete**
60-
> Response204Enveloped running_interactive_services_delete(service_uuid)
60+
> InlineResponse204 running_interactive_services_delete(service_uuid)
6161
6262
Stops and removes an interactive service from the oSparc platform
6363

@@ -87,11 +87,11 @@ except ApiException as e:
8787

8888
Name | Type | Description | Notes
8989
------------- | ------------- | ------------- | -------------
90-
**service_uuid** | [**str**](.md)| The uuid of the service |
90+
**service_uuid** | [**str**](.md)| The uuid of the service |
9191

9292
### Return type
9393

94-
[**Response204Enveloped**](Response204Enveloped.md)
94+
[**InlineResponse204**](InlineResponse204.md)
9595

9696
### Authorization
9797

@@ -105,7 +105,7 @@ No authorization required
105105
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
106106

107107
# **running_interactive_services_get**
108-
> Response204Enveloped running_interactive_services_get(service_uuid)
108+
> InlineResponse204 running_interactive_services_get(service_uuid)
109109
110110
Succesfully returns if a service with the defined uuid is up and running
111111

@@ -135,11 +135,11 @@ except ApiException as e:
135135

136136
Name | Type | Description | Notes
137137
------------- | ------------- | ------------- | -------------
138-
**service_uuid** | [**str**](.md)| The uuid of the service |
138+
**service_uuid** | [**str**](.md)| The uuid of the service |
139139

140140
### Return type
141141

142-
[**Response204Enveloped**](Response204Enveloped.md)
142+
[**InlineResponse204**](InlineResponse204.md)
143143

144144
### Authorization
145145

@@ -153,7 +153,7 @@ No authorization required
153153
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
154154

155155
# **running_interactive_services_post**
156-
> RunningServiceEnveloped running_interactive_services_post(service_key, service_uuid, service_tag=service_tag)
156+
> InlineResponse201 running_interactive_services_post(service_key, service_uuid, service_tag=service_tag)
157157
158158
Starts an interactive service in the oSparc platform and returns its entrypoint
159159

@@ -185,13 +185,13 @@ except ApiException as e:
185185

186186
Name | Type | Description | Notes
187187
------------- | ------------- | ------------- | -------------
188-
**service_key** | **str**| The key (url) of the service |
189-
**service_uuid** | [**str**](.md)| The uuid to assign the service with |
190-
**service_tag** | **str**| The tag/version of the service | [optional]
188+
**service_key** | **str**| The key (url) of the service |
189+
**service_uuid** | [**str**](.md)| The uuid to assign the service with |
190+
**service_tag** | **str**| The tag/version of the service | [optional]
191191

192192
### Return type
193193

194-
[**RunningServiceEnveloped**](RunningServiceEnveloped.md)
194+
[**InlineResponse201**](InlineResponse201.md)
195195

196196
### Authorization
197197

@@ -205,7 +205,7 @@ No authorization required
205205
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
206206

207207
# **services_by_key_version_get**
208-
> ServicesEnveloped services_by_key_version_get(service_key, service_version)
208+
> InlineResponse2001 services_by_key_version_get(service_key, service_version)
209209
210210
Returns details of the selected service if available in the oSparc platform
211211

@@ -236,12 +236,12 @@ except ApiException as e:
236236

237237
Name | Type | Description | Notes
238238
------------- | ------------- | ------------- | -------------
239-
**service_key** | **str**| The key (url) of the service |
240-
**service_version** | **str**| The tag/version of the service |
239+
**service_key** | **str**| The key (url) of the service |
240+
**service_version** | **str**| The tag/version of the service |
241241

242242
### Return type
243243

244-
[**ServicesEnveloped**](ServicesEnveloped.md)
244+
[**InlineResponse2001**](InlineResponse2001.md)
245245

246246
### Authorization
247247

@@ -255,7 +255,7 @@ No authorization required
255255
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
256256

257257
# **services_get**
258-
> ServicesEnveloped services_get(service_type=service_type)
258+
> InlineResponse2001 services_get(service_type=service_type)
259259
260260
Lists available services in the oSparc platform
261261

@@ -285,11 +285,11 @@ except ApiException as e:
285285

286286
Name | Type | Description | Notes
287287
------------- | ------------- | ------------- | -------------
288-
**service_type** | **str**| The service type: * computational - a computational service * interactive - an interactive service | [optional]
288+
**service_type** | **str**| The service type: * computational - a computational service * interactive - an interactive service | [optional]
289289

290290
### Return type
291291

292-
[**ServicesEnveloped**](ServicesEnveloped.md)
292+
[**InlineResponse2001**](InlineResponse2001.md)
293293

294294
### Authorization
295295

@@ -301,3 +301,4 @@ No authorization required
301301
- **Accept**: application/json
302302

303303
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
304+

‎packages/director-sdk/python/simcore_director_sdk/__init__.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@
2424
from simcore_director_sdk.api_client import ApiClient
2525
from simcore_director_sdk.configuration import Configuration
2626
# import models into sdk package
27-
from simcore_director_sdk.models.error import Error
28-
from simcore_director_sdk.models.error_enveloped import ErrorEnveloped
29-
from simcore_director_sdk.models.health_check import HealthCheck
30-
from simcore_director_sdk.models.health_check_enveloped import HealthCheckEnveloped
31-
from simcore_director_sdk.models.node_meta_v0 import NodeMetaV0
32-
from simcore_director_sdk.models.nodemetav0_authors import Nodemetav0Authors
33-
from simcore_director_sdk.models.response204_enveloped import Response204Enveloped
34-
from simcore_director_sdk.models.running_service import RunningService
35-
from simcore_director_sdk.models.running_service_enveloped import RunningServiceEnveloped
36-
from simcore_director_sdk.models.services_enveloped import ServicesEnveloped
27+
from simcore_director_sdk.models.inline_response200 import InlineResponse200
28+
from simcore_director_sdk.models.inline_response2001 import InlineResponse2001
29+
from simcore_director_sdk.models.inline_response2001_authors import InlineResponse2001Authors
30+
from simcore_director_sdk.models.inline_response200_data import InlineResponse200Data
31+
from simcore_director_sdk.models.inline_response201 import InlineResponse201
32+
from simcore_director_sdk.models.inline_response201_data import InlineResponse201Data
33+
from simcore_director_sdk.models.inline_response204 import InlineResponse204
34+
from simcore_director_sdk.models.inline_response_default import InlineResponseDefault
35+
from simcore_director_sdk.models.inline_response_default_data import InlineResponseDefaultData
36+
from simcore_director_sdk.models.simcore_node import SimcoreNode

0 commit comments

Comments
 (0)