[supervisor] Provide port Name and Description along with the port st…

…atus
gitpod-io · Dec 20, 2021 · f854940 · f854940
1 parent fec0a0a
commit f854940
Show file tree

Hide file tree

Showing 8 changed files with 616 additions and 153 deletions.
diff --git a/components/gitpod-protocol/data/gitpod-schema.json b/components/gitpod-protocol/data/gitpod-schema.json
@@ -39,8 +39,7 @@
                     },
                     "name": {
                         "type": "string",
-                        "deprecationMessage": "The 'name' property is deprecated.",
-                        "description": "Port name (deprecated)."
+                        "description": "Port name."
                     },
                     "protocol": {
                         "type": "string",
@@ -51,6 +50,10 @@
                         ],
                         "deprecationMessage": "The 'protocol' property is deprecated.",
                         "description": "The protocol to be used. (deprecated)"
+                    },
+                    "description": {
+                        "type": "string",
+                        "description": "A description to identify what is this port used for."
                     }
                 },
                 "additionalProperties": false

diff --git a/components/gitpod-protocol/go/gitpod-service.go b/components/gitpod-protocol/go/gitpod-service.go
@@ -1827,9 +1827,11 @@ type ImageConfigFile struct {
 
 // PortConfig is the PortConfig message type
 type PortConfig struct {
-	OnOpen     string  `json:"onOpen,omitempty"`
-	Port       float64 `json:"port,omitempty"`
-	Visibility string  `json:"visibility,omitempty"`
+	OnOpen      string  `json:"onOpen,omitempty"`
+	Port        float64 `json:"port,omitempty"`
+	Visibility  string  `json:"visibility,omitempty"`
+	Description string  `json:"description,omitempty"`
+	Name        string  `json:"name,omitempty"`
 }
 
 // ResolvedPlugins is the ResolvedPlugins message type

diff --git a/components/gitpod-protocol/src/protocol.ts b/components/gitpod-protocol/src/protocol.ts
@@ -684,6 +684,8 @@ export interface PortConfig {
     port: number;
     onOpen?: PortOnOpen;
     visibility?: PortVisibility;
+    description?: string;
+    name?: string;
 }
 export namespace PortConfig {
     export function is(config: any): config is PortConfig {

diff --git a/components/supervisor-api/go/status.pb.go b/components/supervisor-api/go/status.pb.go