Skip to content

Commit 37a9d1e

Browse files
yangcao77yangcao77
authored
update the description of uri to make it more clear (#387)
* rebase master, and update description to registryURL Signed-off-by: Stephanie <[email protected]> * update description Signed-off-by: Stephanie <[email protected]>
1 parent cd9c30e commit 37a9d1e

16 files changed

+186
-58
lines changed

‎crds/workspace.devfile.io_devworkspaces.v1beta1.yaml

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5499,9 +5499,16 @@ spec:
54995499
- name
55005500
type: object
55015501
registryUrl:
5502+
description: Registry URL to pull the parent devfile
5503+
from when using id in the parent reference. To ensure
5504+
the parent devfile gets resolved consistently in different
5505+
environments, it is recommended to always specify
5506+
the `regsitryURL` when `Id` is used.
55025507
type: string
55035508
uri:
5504-
description: Uri of a Devfile yaml file
5509+
description: URI Reference of a parent devfile YAML
5510+
file. It can be a full URL or a relative URI with
5511+
the current devfile as the base URI.
55055512
type: string
55065513
type: object
55075514
volume:
@@ -6891,9 +6898,17 @@ spec:
68916898
type: string
68926899
type: object
68936900
registryUrl:
6901+
description: Registry URL to pull the parent devfile
6902+
from when using id in the parent reference. To
6903+
ensure the parent devfile gets resolved consistently
6904+
in different environments, it is recommended to
6905+
always specify the `regsitryURL` when `Id` is
6906+
used.
68946907
type: string
68956908
uri:
6896-
description: Uri of a Devfile yaml file
6909+
description: URI Reference of a parent devfile YAML
6910+
file. It can be a full URL or a relative URI with
6911+
the current devfile as the base URI.
68976912
type: string
68986913
type: object
68996914
volume:
@@ -7048,6 +7063,11 @@ spec:
70487063
type: object
70497064
type: array
70507065
registryUrl:
7066+
description: Registry URL to pull the parent devfile from
7067+
when using id in the parent reference. To ensure the parent
7068+
devfile gets resolved consistently in different environments,
7069+
it is recommended to always specify the `regsitryURL` when
7070+
`Id` is used.
70517071
type: string
70527072
starterProjects:
70537073
description: Overrides of starterProjects encapsulated in
@@ -7156,7 +7176,9 @@ spec:
71567176
type: object
71577177
type: array
71587178
uri:
7159-
description: Uri of a Devfile yaml file
7179+
description: URI Reference of a parent devfile YAML file.
7180+
It can be a full URL or a relative URI with the current
7181+
devfile as the base URI.
71607182
type: string
71617183
variables:
71627184
additionalProperties:

‎crds/workspace.devfile.io_devworkspaces.yaml

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5504,9 +5504,16 @@ spec:
55045504
- name
55055505
type: object
55065506
registryUrl:
5507+
description: Registry URL to pull the parent devfile
5508+
from when using id in the parent reference. To ensure
5509+
the parent devfile gets resolved consistently in different
5510+
environments, it is recommended to always specify
5511+
the `regsitryURL` when `Id` is used.
55075512
type: string
55085513
uri:
5509-
description: Uri of a Devfile yaml file
5514+
description: URI Reference of a parent devfile YAML
5515+
file. It can be a full URL or a relative URI with
5516+
the current devfile as the base URI.
55105517
type: string
55115518
type: object
55125519
volume:
@@ -6896,9 +6903,17 @@ spec:
68966903
type: string
68976904
type: object
68986905
registryUrl:
6906+
description: Registry URL to pull the parent devfile
6907+
from when using id in the parent reference. To
6908+
ensure the parent devfile gets resolved consistently
6909+
in different environments, it is recommended to
6910+
always specify the `regsitryURL` when `Id` is
6911+
used.
68996912
type: string
69006913
uri:
6901-
description: Uri of a Devfile yaml file
6914+
description: URI Reference of a parent devfile YAML
6915+
file. It can be a full URL or a relative URI with
6916+
the current devfile as the base URI.
69026917
type: string
69036918
type: object
69046919
volume:
@@ -7053,6 +7068,11 @@ spec:
70537068
type: object
70547069
type: array
70557070
registryUrl:
7071+
description: Registry URL to pull the parent devfile from
7072+
when using id in the parent reference. To ensure the parent
7073+
devfile gets resolved consistently in different environments,
7074+
it is recommended to always specify the `regsitryURL` when
7075+
`Id` is used.
70567076
type: string
70577077
starterProjects:
70587078
description: Overrides of starterProjects encapsulated in
@@ -7161,7 +7181,9 @@ spec:
71617181
type: object
71627182
type: array
71637183
uri:
7164-
description: Uri of a Devfile yaml file
7184+
description: URI Reference of a parent devfile YAML file.
7185+
It can be a full URL or a relative URI with the current
7186+
devfile as the base URI.
71657187
type: string
71667188
variables:
71677189
additionalProperties:

‎crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5223,9 +5223,16 @@ spec:
52235223
- name
52245224
type: object
52255225
registryUrl:
5226+
description: Registry URL to pull the parent devfile from
5227+
when using id in the parent reference. To ensure the parent
5228+
devfile gets resolved consistently in different environments,
5229+
it is recommended to always specify the `regsitryURL`
5230+
when `Id` is used.
52265231
type: string
52275232
uri:
5228-
description: Uri of a Devfile yaml file
5233+
description: URI Reference of a parent devfile YAML file.
5234+
It can be a full URL or a relative URI with the current
5235+
devfile as the base URI.
52295236
type: string
52305237
type: object
52315238
volume:
@@ -6561,9 +6568,16 @@ spec:
65616568
type: string
65626569
type: object
65636570
registryUrl:
6571+
description: Registry URL to pull the parent devfile
6572+
from when using id in the parent reference. To ensure
6573+
the parent devfile gets resolved consistently in different
6574+
environments, it is recommended to always specify
6575+
the `regsitryURL` when `Id` is used.
65646576
type: string
65656577
uri:
6566-
description: Uri of a Devfile yaml file
6578+
description: URI Reference of a parent devfile YAML
6579+
file. It can be a full URL or a relative URI with
6580+
the current devfile as the base URI.
65676581
type: string
65686582
type: object
65696583
volume:
@@ -6715,6 +6729,11 @@ spec:
67156729
type: object
67166730
type: array
67176731
registryUrl:
6732+
description: Registry URL to pull the parent devfile from when
6733+
using id in the parent reference. To ensure the parent devfile
6734+
gets resolved consistently in different environments, it is
6735+
recommended to always specify the `regsitryURL` when `Id` is
6736+
used.
67186737
type: string
67196738
starterProjects:
67206739
description: Overrides of starterProjects encapsulated in a parent
@@ -6821,7 +6840,9 @@ spec:
68216840
type: object
68226841
type: array
68236842
uri:
6824-
description: Uri of a Devfile yaml file
6843+
description: URI Reference of a parent devfile YAML file. It can
6844+
be a full URL or a relative URI with the current devfile as
6845+
the base URI.
68256846
type: string
68266847
variables:
68276848
additionalProperties:

‎crds/workspace.devfile.io_devworkspacetemplates.yaml

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5228,9 +5228,16 @@ spec:
52285228
- name
52295229
type: object
52305230
registryUrl:
5231+
description: Registry URL to pull the parent devfile from
5232+
when using id in the parent reference. To ensure the parent
5233+
devfile gets resolved consistently in different environments,
5234+
it is recommended to always specify the `regsitryURL`
5235+
when `Id` is used.
52315236
type: string
52325237
uri:
5233-
description: Uri of a Devfile yaml file
5238+
description: URI Reference of a parent devfile YAML file.
5239+
It can be a full URL or a relative URI with the current
5240+
devfile as the base URI.
52345241
type: string
52355242
type: object
52365243
volume:
@@ -6566,9 +6573,16 @@ spec:
65666573
type: string
65676574
type: object
65686575
registryUrl:
6576+
description: Registry URL to pull the parent devfile
6577+
from when using id in the parent reference. To ensure
6578+
the parent devfile gets resolved consistently in different
6579+
environments, it is recommended to always specify
6580+
the `regsitryURL` when `Id` is used.
65696581
type: string
65706582
uri:
6571-
description: Uri of a Devfile yaml file
6583+
description: URI Reference of a parent devfile YAML
6584+
file. It can be a full URL or a relative URI with
6585+
the current devfile as the base URI.
65726586
type: string
65736587
type: object
65746588
volume:
@@ -6720,6 +6734,11 @@ spec:
67206734
type: object
67216735
type: array
67226736
registryUrl:
6737+
description: Registry URL to pull the parent devfile from when
6738+
using id in the parent reference. To ensure the parent devfile
6739+
gets resolved consistently in different environments, it is
6740+
recommended to always specify the `regsitryURL` when `Id` is
6741+
used.
67236742
type: string
67246743
starterProjects:
67256744
description: Overrides of starterProjects encapsulated in a parent
@@ -6826,7 +6845,9 @@ spec:
68266845
type: object
68276846
type: array
68286847
uri:
6829-
description: Uri of a Devfile yaml file
6848+
description: URI Reference of a parent devfile YAML file. It can
6849+
be a full URL or a relative URI with the current devfile as
6850+
the base URI.
68306851
type: string
68316852
variables:
68326853
additionalProperties:

‎pkg/apis/workspaces/v1alpha2/import_reference.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ type ImportReferenceUnion struct {
2121
// +optional
2222
ImportReferenceType ImportReferenceType `json:"importReferenceType,omitempty"`
2323

24-
// Uri of a Devfile yaml file
24+
// URI Reference of a parent devfile YAML file.
25+
// It can be a full URL or a relative URI with the current devfile as the base URI.
2526
// +optional
2627
Uri string `json:"uri,omitempty"`
2728

@@ -43,6 +44,10 @@ type KubernetesCustomResourceImportReference struct {
4344

4445
type ImportReference struct {
4546
ImportReferenceUnion `json:",inline"`
47+
48+
// Registry URL to pull the parent devfile from when using id in the parent reference.
49+
// To ensure the parent devfile gets resolved consistently in different environments,
50+
// it is recommended to always specify the `regsitryURL` when `Id` is used.
4651
// +optional
4752
RegistryUrl string `json:"registryUrl,omitempty"`
4853
}

‎pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎schemas/latest/dev-workspace-template-spec.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1255,10 +1255,11 @@
12551255
"additionalProperties": false
12561256
},
12571257
"registryUrl": {
1258+
"description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `regsitryURL` when `Id` is used.",
12581259
"type": "string"
12591260
},
12601261
"uri": {
1261-
"description": "Uri of a Devfile yaml file",
1262+
"description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.",
12621263
"type": "string"
12631264
}
12641265
},
@@ -2479,10 +2480,11 @@
24792480
"additionalProperties": false
24802481
},
24812482
"registryUrl": {
2483+
"description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `regsitryURL` when `Id` is used.",
24822484
"type": "string"
24832485
},
24842486
"uri": {
2485-
"description": "Uri of a Devfile yaml file",
2487+
"description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.",
24862488
"type": "string"
24872489
}
24882490
},
@@ -2649,6 +2651,7 @@
26492651
}
26502652
},
26512653
"registryUrl": {
2654+
"description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `regsitryURL` when `Id` is used.",
26522655
"type": "string"
26532656
},
26542657
"starterProjects": {
@@ -2770,7 +2773,7 @@
27702773
}
27712774
},
27722775
"uri": {
2773-
"description": "Uri of a Devfile yaml file",
2776+
"description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.",
27742777
"type": "string"
27752778
},
27762779
"variables": {

‎schemas/latest/dev-workspace-template.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1420,10 +1420,11 @@
14201420
"additionalProperties": false
14211421
},
14221422
"registryUrl": {
1423+
"description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `regsitryURL` when `Id` is used.",
14231424
"type": "string"
14241425
},
14251426
"uri": {
1426-
"description": "Uri of a Devfile yaml file",
1427+
"description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.",
14271428
"type": "string"
14281429
}
14291430
},
@@ -2644,10 +2645,11 @@
26442645
"additionalProperties": false
26452646
},
26462647
"registryUrl": {
2648+
"description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `regsitryURL` when `Id` is used.",
26472649
"type": "string"
26482650
},
26492651
"uri": {
2650-
"description": "Uri of a Devfile yaml file",
2652+
"description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.",
26512653
"type": "string"
26522654
}
26532655
},
@@ -2814,6 +2816,7 @@
28142816
}
28152817
},
28162818
"registryUrl": {
2819+
"description": "Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `regsitryURL` when `Id` is used.",
28172820
"type": "string"
28182821
},
28192822
"starterProjects": {
@@ -2935,7 +2938,7 @@
29352938
}
29362939
},
29372940
"uri": {
2938-
"description": "Uri of a Devfile yaml file",
2941+
"description": "URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.",
29392942
"type": "string"
29402943
},
29412944
"variables": {

0 commit comments

Comments
 (0)