Rename Theia.Cloud to Theia Cloud and Improve Ingress/Host configurat…

…ion (#314) * Update Theia.Cloud to Theia Cloud * regenerate common API using older version of opanapi generator * adjust to helm renames because of Ingress/Host configuration improvements Contributed on behalf of STMicroelectronics Co-authored-by: Simon Graband <[email protected]>
eclipse-theia · Jul 1, 2024 · 9e06317 · 9e06317
1 parent 5a5538b
commit 9e06317
Show file tree

Hide file tree

Showing 22 changed files with 118 additions and 103 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,10 @@
   - Build the common package as ESM and CJS bundles for extended compatibility
 - [common] Add `ingressHostnamePrefixes` list to `AppDefinition.v1beta10` [#298](https://github.com/eclipsesource/theia-cloud/pull/298) | [#57](https://github.com/eclipsesource/theia-cloud-helm/pull/57)
 
+### Breaking Changes in 0.11.0
+
+See the helm chart Changelog for [more details](https://github.com/eclipsesource/theia-cloud-helm/blob/main/CHANGELOG.md).
+
 ## [0.10.0] - 2024-04-02
 
 - [.github/workflows] Improve version detection in workflows (do not build release commits, auto-detect version for demo publishing) [#280](https://github.com/eclipsesource/theia-cloud/pull/280) - contributed on behalf of STMicroelectronics

diff --git a/documentation/Install.md b/documentation/Install.md
@@ -57,9 +57,11 @@ Open `./terraform/values/valuesDemo.yaml` and update the host section to use `su
 
 ```yaml
 hosts:
-  service: service.34.141.62.32.nip.io
-  landing: theia.cloud.34.141.62.32.nip.io
-  instance: ws.34.141.62.32.nip.io
+  configuration:
+    baseHost: 34.141.62.32.nip.io
+    service: service
+    landing: theia-cloud
+    instance: ws
 ```
 
 ### Add & update Theia Cloud helm repo

diff --git a/documentation/OpenAPI.md b/documentation/OpenAPI.md
@@ -40,6 +40,7 @@ Install the `openapi-generator-cli`:
 
 ```bash
 npm install @openapitools/openapi-generator-cli -g
+openapi-generator-cli version-manager set 6.6.0
 ```
 
 Use the `openapi-generator-cli` from the root of this repository:

diff --git a/documentation/openapi.json b/documentation/openapi.json
@@ -1,8 +1,8 @@
 {
   "openapi" : "3.0.3",
   "info" : {
-    "title" : "Theia.cloud API",
-    "version" : "0.9.0"
+    "title" : "Theia Cloud API",
+    "version" : "0.11.0"
   },
   "paths" : {
     "/service" : {
@@ -23,7 +23,7 @@
           "200" : {
             "description" : "OK",
             "content" : {
-              "application/json" : {
+              "text/plain" : {
                 "schema" : {
                   "type" : "string"
                 }
@@ -60,7 +60,7 @@
           "200" : {
             "description" : "OK",
             "content" : {
-              "application/json" : {
+              "text/plain" : {
                 "schema" : {
                   "type" : "string"
                 }
@@ -95,7 +95,7 @@
           "200" : {
             "description" : "OK",
             "content" : {
-              "application/json" : {
+              "text/plain" : {
                 "schema" : {
                   "type" : "boolean"
                 }
@@ -130,7 +130,7 @@
           "200" : {
             "description" : "OK",
             "content" : {
-              "application/json" : {
+              "text/plain" : {
                 "schema" : {
                   "type" : "boolean"
                 }
@@ -291,7 +291,7 @@
           "200" : {
             "description" : "OK",
             "content" : {
-              "application/json" : {
+              "text/plain" : {
                 "schema" : {
                   "type" : "boolean"
                 }
@@ -373,7 +373,7 @@
           "200" : {
             "description" : "OK",
             "content" : {
-              "application/json" : {
+              "text/plain" : {
                 "schema" : {
                   "type" : "boolean"
                 }
@@ -428,7 +428,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "user" : {
@@ -471,7 +471,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           }
         }
@@ -482,7 +482,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "sessionName" : {
@@ -497,7 +497,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "user" : {
@@ -535,7 +535,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "sessionName" : {
@@ -556,22 +556,18 @@
           "user" : {
             "type" : "string"
           },
-          "url" : {
-            "type" : "string"
-          },
-          "error" : {
-            "type" : "string"
-          },
           "workspace" : {
             "type" : "string"
           },
-          "lastActivity" : {
-            "format" : "int64",
-            "type" : "integer"
-          },
           "sessionSecret" : {
             "type" : "string"
           },
+          "options" : {
+            "type" : "object",
+            "additionalProperties" : {
+              "type" : "string"
+            }
+          },
           "envVars" : {
             "type" : "object",
             "additionalProperties" : {
@@ -598,7 +594,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "user" : {
@@ -633,7 +629,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "user" : {
@@ -679,7 +675,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "user" : {
@@ -702,7 +698,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "user" : {
@@ -721,7 +717,7 @@
         "type" : "object",
         "properties" : {
           "appId" : {
-            "description" : "The App Id of this Theia.cloud instance. Request without a matching Id will be denied.",
+            "description" : "The App Id of this Theia Cloud instance. Request without a matching Id will be denied.",
             "type" : "string"
           },
           "user" : {

diff --git a/documentation/platforms/Minikube.md b/documentation/platforms/Minikube.md
@@ -22,7 +22,7 @@ In Chrome:
 In Firefox:
 `Warning: Potential Security Risk Ahead -> Advanced... -> Accept the Risk and Continue`
 
-## Testing local Theia.cloud images
+## Testing local Theia Cloud images
 
 You can test locally build images (e.g. of the landing page, service, or operator) by building them in Minikube and then using them in the Minikube Helm chart.
 

diff --git a/documentation/theiacloud.graphml b/documentation/theiacloud.graphml
@@ -278,7 +278,7 @@ user: [email protected]<y:LabelModel><y:ErdAttributesNodeLabelModel/></y:LabelModel><y
                   <y:Geometry height="136.875" width="293.75" x="-51.25" y="513.5895833333336"/>
                   <y:Fill color="#E8EEF7" color2="#B7C9E3" transparent="false"/>
                   <y:BorderStyle color="#000000" type="line" width="1.0"/>
-                  <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="118.45703125" x="87.646484375" xml:space="preserve" y="59.453125">Theia.cloud Service<y:LabelModel><y:SmartNodeLabelModel distance="4.0"/></y:LabelModel><y:ModelParameter><y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/></y:ModelParameter></y:NodeLabel>
+                  <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="17.96875" horizontalTextPosition="center" iconTextGap="4" modelName="custom" textColor="#000000" verticalTextPosition="bottom" visible="true" width="118.45703125" x="87.646484375" xml:space="preserve" y="59.453125">Theia Cloud Service<y:LabelModel><y:SmartNodeLabelModel distance="4.0"/></y:LabelModel><y:ModelParameter><y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="0.0" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/></y:ModelParameter></y:NodeLabel>
                   <y:StyleProperties>
                     <y:Property class="java.lang.Boolean" name="y.view.ShadowNodePainter.SHADOW_PAINTING" value="true"/>
                   </y:StyleProperties>

diff --git a/...cloud.service/src/main/java/org/eclipse/theia/cloud/service/TheiaCloudApiApplication.java b/...cloud.service/src/main/java/org/eclipse/theia/cloud/service/TheiaCloudApiApplication.java
@@ -20,6 +20,6 @@
 
 import jakarta.ws.rs.core.Application;
 
-@OpenAPIDefinition(info = @Info(title = "Theia.cloud API", version = "0.10.0"))
+@OpenAPIDefinition(info = @Info(title = "Theia Cloud API", version = "0.11.0"))
 public class TheiaCloudApiApplication extends Application {
 }
diff --git a/node/common/src/client/api.ts b/node/common/src/client/api.ts
@@ -1,10 +1,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Theia.cloud API
+ * Theia Cloud API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 0.8.0
+ * The version of the OpenAPI document: 0.11.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -55,7 +55,7 @@ export interface EnvironmentVars {
  */
 export interface LaunchRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof LaunchRequest
      */
@@ -104,7 +104,7 @@ export interface LaunchRequest {
     'env'?: LaunchRequestEnv;
 }
 /**
- * 
+ * Environment variables
  * @export
  * @interface LaunchRequestEnv
  */
@@ -135,7 +135,7 @@ export interface LaunchRequestEnv {
  */
 export interface PingRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof PingRequest
      */
@@ -148,7 +148,7 @@ export interface PingRequest {
  */
 export interface SessionActivityRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof SessionActivityRequest
      */
@@ -167,7 +167,7 @@ export interface SessionActivityRequest {
  */
 export interface SessionListRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof SessionListRequest
      */
@@ -217,7 +217,7 @@ export interface SessionPerformance {
  */
 export interface SessionPerformanceRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof SessionPerformanceRequest
      */
@@ -253,18 +253,6 @@ export interface SessionSpec {
      * @memberof SessionSpec
      */
     'user'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof SessionSpec
-     */
-    'url'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof SessionSpec
-     */
-    'error'?: string;
     /**
      * 
      * @type {string}
@@ -273,16 +261,16 @@ export interface SessionSpec {
     'workspace'?: string;
     /**
      * 
-     * @type {number}
+     * @type {string}
      * @memberof SessionSpec
      */
-    'lastActivity'?: number;
+    'sessionSecret'?: string;
     /**
      * 
-     * @type {string}
+     * @type {{ [key: string]: string; }}
      * @memberof SessionSpec
      */
-    'sessionSecret'?: string;
+    'options'?: { [key: string]: string; };
     /**
      * 
      * @type {{ [key: string]: string; }}
@@ -309,7 +297,7 @@ export interface SessionSpec {
  */
 export interface SessionStartRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof SessionStartRequest
      */
@@ -352,7 +340,7 @@ export interface SessionStartRequest {
  */
 export interface SessionStopRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof SessionStopRequest
      */
@@ -414,7 +402,7 @@ export interface UserWorkspace {
  */
 export interface WorkspaceCreationRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof WorkspaceCreationRequest
      */
@@ -445,7 +433,7 @@ export interface WorkspaceCreationRequest {
  */
 export interface WorkspaceDeletionRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof WorkspaceDeletionRequest
      */
@@ -470,7 +458,7 @@ export interface WorkspaceDeletionRequest {
  */
 export interface WorkspaceListRequest {
     /**
-     * The App Id of this Theia.cloud instance. Request without a matching Id will be denied.
+     * The App Id of this Theia Cloud instance. Request without a matching Id will be denied.
      * @type {string}
      * @memberof WorkspaceListRequest
      */