Merge pull request #10 from sanderegg/reverse_proxy_director_update

updated director such that the route running_services get returns the service and the necessary details

Author: pcrespov

api/specs/director/v0/openapi.yaml

@@ -12,8 +12,6 @@ info:
     url: https://github.com/ITISFoundation/osparc-simcore/blob/master/LICENSE
 
 servers:
-  - description: API server
-    url: '/v0'
   - description: Development server
     url: http://{host}:{port}/{version}
     variables:
@@ -25,6 +23,16 @@ servers:
         default: 'v0'
         enum:
           - 'v0'
+  - description: Production server    
+    url: http://director:{port}/{version}
+    variables:
+      port:
+        default: '8001'
+      version:
+        default: 'v0'
+        enum:
+          - 'v0'
+  
 
 # tags are used for organizing operations
 tags:
@@ -182,12 +190,12 @@ paths:
       parameters:
         - $ref: '#/components/parameters/ServiceUuid'
       responses:
-        "204":
-          description: OK service exists and runs
+        "200":
+          description: OK service exists and runs. Returns service location.
           content:
             application/json:
               schema:
-                $ref: '../../shared/schemas/response204.yaml#/components/schemas/Response204Enveloped'
+                $ref: '../../shared/schemas/running_service.yaml#/components/schemas/RunningServiceEnveloped'
         "400":
           description: Malformed function call, missing field
           content:
@@ -258,7 +266,7 @@ components:
       required: true
       schema:
         type: string
-        format: uuid
+        # format: uuid
         example: 123e4567-e89b-12d3-a456-426655440000
 
     ServiceKeyPath:
@@ -268,8 +276,11 @@ components:
       required: true
       schema:
         type: string
-        format: url
-        example: simcore/services/dynamic/3d-viewer
+        description: distinctive name for the node based on the docker registry path
+        pattern: '^(simcore)/(services)/(comp|dynamic)(/[^\s/]+)+$'
+        example:
+          - simcore/services/comp/itis/sleeper
+          - simcore/services/dynamic/3dviewer
 
     ServiceKey:
       in: query
@@ -278,8 +289,11 @@ components:
       required: true
       schema:
         type: string
-        format: url
-        example: simcore/services/dynamic/3d-viewer
+        description: distinctive name for the node based on the docker registry path
+        pattern: '^(simcore)/(services)/(comp|dynamic)(/[^\s/]+)+$'
+        example:
+          - simcore/services/comp/itis/sleeper
+          - simcore/services/dynamic/3dviewer
 
     ServiceType:
       in: query
@@ -303,7 +317,7 @@ components:
       required: true
       schema:
         type: string
-        format: uuid
+        # format: uuid
         example: 123e4567-e89b-12d3-a456-426655440000
 
     ServiceVersionPath:
@@ -313,7 +327,12 @@ components:
       required: true
       schema:
         type: string
-        example: "1.4"
+        description: semantic version number
+        pattern: >-
+          ^(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-]+)*)?$
+        example:
+          - 1.0.0
+          - 0.0.1
 
     ServiceVersion:
       in: query
@@ -322,4 +341,9 @@ components:
       required: false
       schema:
         type: string
-        example: "1.4"
+        description: semantic version number
+        pattern: >-
+          ^(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-]+)*)?$
+        example:
+          - 1.0.0
+          - 0.0.1

api/specs/shared/schemas/running_service.yaml

@@ -16,6 +16,8 @@ components:
       required:
         - published_port
         - service_uuid
+        - service_key
+        - service_version
       properties:
         published_port:
           description: The ports where the service provides its interface
@@ -30,5 +32,20 @@ components:
         service_uuid:
           description: The UUID attached to this service
           type: string
-          format: UUID
+          # format: UUID
           example: 123e4567-e89b-12d3-a456-426655440000
+        service_key:
+          type: string
+          description: distinctive name for the node based on the docker registry path
+          pattern: '^(simcore)/(services)/(comp|dynamic)(/[^\s/]+)+$'
+          example:
+            - simcore/services/comp/itis/sleeper
+            - simcore/services/dynamic/3dviewer
+        service_version:
+          type: string
+          description: semantic version number
+          pattern: >-
+            ^(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-]+)*)?$
+          example:
+            - 1.0.0
+            - 0.0.1

api/specs/webserver/v0/components/schemas/my.yaml

@@ -32,6 +32,13 @@ Token:
     service: 'github-api-v1'
     token_key: N1BP5ZSpB
 
+
+TokenId:
+  description: toke identifier
+  type: string
+  # format: uuid
+
+
 # enveloped and array versions --------------------------
 
 ProfileEnveloped:
@@ -70,3 +77,14 @@ TokensArrayEnveloped:
     error:
       nullable: true
       default: null
+
+TokenIdEnveloped:
+  type: object
+  required:
+    - data
+  properties:
+    data:
+      $ref: '#/TokenId'
+    error:
+      nullable: true
+      default: null

api/specs/webserver/v0/openapi-user.yaml

@@ -44,6 +44,11 @@ paths:
       responses:
         '201':
           description: token created
+          content:
+            application/json:
+              schema:
+                $ref: './components/schemas/my.yaml#/TokenIdEnveloped'
+
         default:
           $ref: './openapi.yaml#/components/responses/DefaultErrorResponse'
 

packages/director-sdk/codegen.sh

@@ -1,6 +1,9 @@
 #/bin/bash
-exec ../../scripts/openapi/openapi_codegen.sh \
-    -i ../../services/director/src/simcore_service_director/oas3/v0/openapi.yaml \
+docker build ../../scripts/openapi/oas_resolver -t oas_resolver
+docker run -v ${PWD}/../../api/specs:/input -v ${PWD}:/output oas_resolver /input/director/v0/openapi.yaml /output/output_file.yaml
+
+../../scripts/openapi/openapi_codegen.sh \
+    -i output_file.yaml \
     -o . \
     -g python \
     -c ./codegen_config.json

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

@@ -1 +1 @@
-3.3.2
+3.3.3

packages/director-sdk/python/README.md

@@ -3,7 +3,7 @@ This is the oSparc's director API
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0
+- API version: 0.1.0
 - Package version: 1.0.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 

packages/director-sdk/python/docs/InlineResponse201Data.md

@@ -5,7 +5,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entry_point** | **str** | The entry point where the service provides its interface if specified | [optional] 
 **published_port** | **int** | The ports where the service provides its interface | 
+**service_key** | **str** | distinctive name for the node based on the docker registry path | 
 **service_uuid** | **str** | The UUID attached to this service | 
+**service_version** | **str** | semantic version number | 
 
 [[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/UsersApi.md

@@ -87,7 +87,7 @@ except ApiException as e:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **service_uuid** | [**str**](.md)| The uuid of the service | 
+ **service_uuid** | **str**| The uuid of the service | 
 
 ### Return type
 
@@ -105,7 +105,7 @@ No authorization required
 [[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)
 
 # **running_interactive_services_get**
-> InlineResponse204 running_interactive_services_get(service_uuid)
+> InlineResponse201 running_interactive_services_get(service_uuid)
 
 Succesfully returns if a service with the defined uuid is up and running
 
@@ -135,11 +135,11 @@ except ApiException as e:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **service_uuid** | [**str**](.md)| The uuid of the service | 
+ **service_uuid** | **str**| The uuid of the service | 
 
 ### Return type
 
-[**InlineResponse204**](InlineResponse204.md)
+[**InlineResponse201**](InlineResponse201.md)
 
 ### Authorization
 
@@ -170,9 +170,9 @@ from pprint import pprint
 # create an instance of the API class
 api_instance = simcore_director_sdk.UsersApi()
 user_id = asdfgj233 # str | The ID of the user that starts the service
-service_key = simcore/services/dynamic/3d-viewer # str | The key (url) of the service
+service_key = ["simcore/services/comp/itis/sleeper","simcore/services/dynamic/3dviewer"] # str | The key (url) of the service
 service_uuid = 123e4567-e89b-12d3-a456-426655440000 # str | The uuid to assign the service with
-service_tag = 1.4 # str | The tag/version of the service (optional)
+service_tag = ["1.0.0","0.0.1"] # str | The tag/version of the service (optional)
 
 try:
     # Starts an interactive service in the oSparc platform and returns its entrypoint
@@ -188,7 +188,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_id** | **str**| The ID of the user that starts the service | 
  **service_key** | **str**| The key (url) of the service | 
- **service_uuid** | [**str**](.md)| The uuid to assign the service with | 
+ **service_uuid** | **str**| The uuid to assign the service with | 
  **service_tag** | **str**| The tag/version of the service | [optional] 
 
 ### Return type
@@ -223,8 +223,8 @@ from pprint import pprint
 
 # create an instance of the API class
 api_instance = simcore_director_sdk.UsersApi()
-service_key = simcore/services/dynamic/3d-viewer # str | The key (url) of the service
-service_version = 1.4 # str | The tag/version of the service
+service_key = ["simcore/services/comp/itis/sleeper","simcore/services/dynamic/3dviewer"] # str | The key (url) of the service
+service_version = ["1.0.0","0.0.1"] # str | The tag/version of the service
 
 try:
     # Returns details of the selected service if available in the oSparc platform

packages/director-sdk/python/setup.py

@@ -5,7 +5,7 @@
 
     This is the oSparc's director API  # noqa: E501
 
-    OpenAPI spec version: 1.0.0
+    OpenAPI spec version: 0.1.0
     Contact: [email protected]
     Generated by: https://openapi-generator.tech
 """

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

@@ -7,7 +7,7 @@
 
     This is the oSparc's director API  # noqa: E501
 
-    OpenAPI spec version: 1.0.0
+    OpenAPI spec version: 0.1.0
     Contact: [email protected]
     Generated by: https://openapi-generator.tech
 """

packages/director-sdk/python/simcore_director_sdk/api/users_api.py

@@ -5,7 +5,7 @@
 
     This is the oSparc's director API  # noqa: E501
 
-    OpenAPI spec version: 1.0.0
+    OpenAPI spec version: 0.1.0
     Contact: [email protected]
     Generated by: https://openapi-generator.tech
 """
@@ -228,7 +228,7 @@ def running_interactive_services_get(self, service_uuid, **kwargs):  # noqa: E50
 
         :param async_req bool
         :param str service_uuid: The uuid of the service (required)
-        :return: InlineResponse204
+        :return: InlineResponse201
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -250,7 +250,7 @@ def running_interactive_services_get_with_http_info(self, service_uuid, **kwargs
 
         :param async_req bool
         :param str service_uuid: The uuid of the service (required)
-        :return: InlineResponse204
+        :return: InlineResponse201
                  If the method is called asynchronously,
                  returns the request thread.
         """
@@ -305,7 +305,7 @@ def running_interactive_services_get_with_http_info(self, service_uuid, **kwargs
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='InlineResponse204',  # noqa: E501
+            response_type='InlineResponse201',  # noqa: E501
             auth_settings=auth_settings,
             async_req=local_var_params.get('async_req'),
             _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
@@ -386,6 +386,10 @@ def running_interactive_services_post_with_http_info(self, user_id, service_key,
                 local_var_params['service_uuid'] is None):
             raise ValueError("Missing the required parameter `service_uuid` when calling `running_interactive_services_post`")  # noqa: E501
 
+        if 'service_key' in local_var_params and not re.search('^(simcore)\/(services)\/(comp|dynamic)(\/[^\\s\/]+)+$', local_var_params['service_key']):  # noqa: E501
+            raise ValueError("Invalid value for parameter `service_key` when calling `running_interactive_services_post`, must conform to the pattern `/^(simcore)\/(services)\/(comp|dynamic)(\/[^\\s\/]+)+$/`")  # noqa: E501
+        if 'service_tag' in local_var_params and not re.search('^(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-]+)*)?$', local_var_params['service_tag']):  # noqa: E501
+            raise ValueError("Invalid value for parameter `service_tag` when calling `running_interactive_services_post`, must conform to the pattern `/^(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-]+)*)?$/`")  # noqa: E501
         collection_formats = {}
 
         path_params = {}
@@ -494,6 +498,10 @@ def services_by_key_version_get_with_http_info(self, service_key, service_versio
                 local_var_params['service_version'] is None):
             raise ValueError("Missing the required parameter `service_version` when calling `services_by_key_version_get`")  # noqa: E501
 
+        if 'service_key' in local_var_params and not re.search('^(simcore)\/(services)\/(comp|dynamic)(\/[^\\s\/]+)+$', local_var_params['service_key']):  # noqa: E501
+            raise ValueError("Invalid value for parameter `service_key` when calling `services_by_key_version_get`, must conform to the pattern `/^(simcore)\/(services)\/(comp|dynamic)(\/[^\\s\/]+)+$/`")  # noqa: E501
+        if 'service_version' in local_var_params and not re.search('^(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-]+)*)?$', local_var_params['service_version']):  # noqa: E501
+            raise ValueError("Invalid value for parameter `service_version` when calling `services_by_key_version_get`, must conform to the pattern `/^(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-]+)*)?$/`")  # noqa: E501
         collection_formats = {}
 
         path_params = {}