Skip to content

Commit f854940

Browse files
felladrinroboquat
authored andcommitted
[supervisor] Provide port Name and Description along with the port status
1 parent fec0a0a commit f854940

File tree

8 files changed

+616
-153
lines changed

8 files changed

+616
-153
lines changed

components/gitpod-protocol/data/gitpod-schema.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@
3939
},
4040
"name": {
4141
"type": "string",
42-
"deprecationMessage": "The 'name' property is deprecated.",
43-
"description": "Port name (deprecated)."
42+
"description": "Port name."
4443
},
4544
"protocol": {
4645
"type": "string",
@@ -51,6 +50,10 @@
5150
],
5251
"deprecationMessage": "The 'protocol' property is deprecated.",
5352
"description": "The protocol to be used. (deprecated)"
53+
},
54+
"description": {
55+
"type": "string",
56+
"description": "A description to identify what is this port used for."
5457
}
5558
},
5659
"additionalProperties": false

components/gitpod-protocol/go/gitpod-service.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1827,9 +1827,11 @@ type ImageConfigFile struct {
18271827

18281828
// PortConfig is the PortConfig message type
18291829
type PortConfig struct {
1830-
OnOpen string `json:"onOpen,omitempty"`
1831-
Port float64 `json:"port,omitempty"`
1832-
Visibility string `json:"visibility,omitempty"`
1830+
OnOpen string `json:"onOpen,omitempty"`
1831+
Port float64 `json:"port,omitempty"`
1832+
Visibility string `json:"visibility,omitempty"`
1833+
Description string `json:"description,omitempty"`
1834+
Name string `json:"name,omitempty"`
18331835
}
18341836

18351837
// ResolvedPlugins is the ResolvedPlugins message type

components/gitpod-protocol/src/protocol.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -684,6 +684,8 @@ export interface PortConfig {
684684
port: number;
685685
onOpen?: PortOnOpen;
686686
visibility?: PortVisibility;
687+
description?: string;
688+
name?: string;
687689
}
688690
export namespace PortConfig {
689691
export function is(config: any): config is PortConfig {

components/supervisor-api/go/status.pb.go

Lines changed: 124 additions & 103 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)