diff --git a/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml b/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml index ff7558d17..74c58786d 100644 --- a/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml +++ b/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml @@ -5499,9 +5499,16 @@ spec: - name type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -6891,9 +6898,17 @@ spec: type: string type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -7048,6 +7063,11 @@ spec: type: object type: array registryUrl: + 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. type: string starterProjects: description: Overrides of starterProjects encapsulated in @@ -7156,7 +7176,9 @@ spec: type: object type: array uri: - description: Uri of a Devfile yaml file + 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. type: string variables: additionalProperties: diff --git a/crds/workspace.devfile.io_devworkspaces.yaml b/crds/workspace.devfile.io_devworkspaces.yaml index 398810316..d86fa716a 100644 --- a/crds/workspace.devfile.io_devworkspaces.yaml +++ b/crds/workspace.devfile.io_devworkspaces.yaml @@ -5504,9 +5504,16 @@ spec: - name type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -6896,9 +6903,17 @@ spec: type: string type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -7053,6 +7068,11 @@ spec: type: object type: array registryUrl: + 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. type: string starterProjects: description: Overrides of starterProjects encapsulated in @@ -7161,7 +7181,9 @@ spec: type: object type: array uri: - description: Uri of a Devfile yaml file + 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. type: string variables: additionalProperties: diff --git a/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml b/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml index fda3dc322..a3b0a58eb 100644 --- a/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml +++ b/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml @@ -5223,9 +5223,16 @@ spec: - name type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -6561,9 +6568,16 @@ spec: type: string type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -6715,6 +6729,11 @@ spec: type: object type: array registryUrl: + 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. type: string starterProjects: description: Overrides of starterProjects encapsulated in a parent @@ -6821,7 +6840,9 @@ spec: type: object type: array uri: - description: Uri of a Devfile yaml file + 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. type: string variables: additionalProperties: diff --git a/crds/workspace.devfile.io_devworkspacetemplates.yaml b/crds/workspace.devfile.io_devworkspacetemplates.yaml index 1645b72cc..4ab323939 100644 --- a/crds/workspace.devfile.io_devworkspacetemplates.yaml +++ b/crds/workspace.devfile.io_devworkspacetemplates.yaml @@ -5228,9 +5228,16 @@ spec: - name type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -6566,9 +6573,16 @@ spec: type: string type: object registryUrl: + 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. type: string uri: - description: Uri of a Devfile yaml file + 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. type: string type: object volume: @@ -6720,6 +6734,11 @@ spec: type: object type: array registryUrl: + 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. type: string starterProjects: description: Overrides of starterProjects encapsulated in a parent @@ -6826,7 +6845,9 @@ spec: type: object type: array uri: - description: Uri of a Devfile yaml file + 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. type: string variables: additionalProperties: diff --git a/pkg/apis/workspaces/v1alpha2/import_reference.go b/pkg/apis/workspaces/v1alpha2/import_reference.go index a1b5bc88f..d422cdca2 100644 --- a/pkg/apis/workspaces/v1alpha2/import_reference.go +++ b/pkg/apis/workspaces/v1alpha2/import_reference.go @@ -21,7 +21,8 @@ type ImportReferenceUnion struct { // +optional ImportReferenceType ImportReferenceType `json:"importReferenceType,omitempty"` - // Uri of a Devfile yaml file + // 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. // +optional Uri string `json:"uri,omitempty"` @@ -43,6 +44,10 @@ type KubernetesCustomResourceImportReference struct { type ImportReference struct { ImportReferenceUnion `json:",inline"` + + // 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. // +optional RegistryUrl string `json:"registryUrl,omitempty"` } diff --git a/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go b/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go index 7d19fe6a1..9951ed400 100644 --- a/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go +++ b/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go @@ -507,6 +507,9 @@ type VolumeParentOverride struct { type ImportReferenceParentOverride struct { ImportReferenceUnionParentOverride `json:",inline"` + // 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. // +optional RegistryUrl string `json:"registryUrl,omitempty"` } @@ -617,7 +620,8 @@ type ImportReferenceUnionParentOverride struct { // +optional ImportReferenceType ImportReferenceTypeParentOverride `json:"importReferenceType,omitempty"` - // Uri of a Devfile yaml file + // 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. // +optional Uri string `json:"uri,omitempty"` diff --git a/schemas/latest/dev-workspace-template-spec.json b/schemas/latest/dev-workspace-template-spec.json index 43bf992cc..8dfe76292 100644 --- a/schemas/latest/dev-workspace-template-spec.json +++ b/schemas/latest/dev-workspace-template-spec.json @@ -1255,10 +1255,11 @@ "additionalProperties": false }, "registryUrl": { + "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.", "type": "string" }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" } }, @@ -2479,10 +2480,11 @@ "additionalProperties": false }, "registryUrl": { + "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.", "type": "string" }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" } }, @@ -2649,6 +2651,7 @@ } }, "registryUrl": { + "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.", "type": "string" }, "starterProjects": { @@ -2770,7 +2773,7 @@ } }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" }, "variables": { diff --git a/schemas/latest/dev-workspace-template.json b/schemas/latest/dev-workspace-template.json index 3366199a8..ba2ad9c5d 100644 --- a/schemas/latest/dev-workspace-template.json +++ b/schemas/latest/dev-workspace-template.json @@ -1420,10 +1420,11 @@ "additionalProperties": false }, "registryUrl": { + "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.", "type": "string" }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" } }, @@ -2644,10 +2645,11 @@ "additionalProperties": false }, "registryUrl": { + "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.", "type": "string" }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" } }, @@ -2814,6 +2816,7 @@ } }, "registryUrl": { + "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.", "type": "string" }, "starterProjects": { @@ -2935,7 +2938,7 @@ } }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" }, "variables": { diff --git a/schemas/latest/dev-workspace.json b/schemas/latest/dev-workspace.json index 84d871ddf..09b0cfe6c 100644 --- a/schemas/latest/dev-workspace.json +++ b/schemas/latest/dev-workspace.json @@ -1433,10 +1433,11 @@ "additionalProperties": false }, "registryUrl": { + "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.", "type": "string" }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" } }, @@ -2657,10 +2658,11 @@ "additionalProperties": false }, "registryUrl": { + "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.", "type": "string" }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" } }, @@ -2827,6 +2829,7 @@ } }, "registryUrl": { + "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.", "type": "string" }, "starterProjects": { @@ -2948,7 +2951,7 @@ } }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" }, "variables": { diff --git a/schemas/latest/devfile.json b/schemas/latest/devfile.json index 7cb0eb71e..8ee947f86 100644 --- a/schemas/latest/devfile.json +++ b/schemas/latest/devfile.json @@ -1411,6 +1411,7 @@ } }, "registryUrl": { + "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.", "type": "string" }, "starterProjects": { @@ -1532,7 +1533,7 @@ } }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" }, "variables": { diff --git a/schemas/latest/ide-targeted/dev-workspace-template-spec.json b/schemas/latest/ide-targeted/dev-workspace-template-spec.json index 32e4561f4..51ae599a3 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template-spec.json +++ b/schemas/latest/ide-targeted/dev-workspace-template-spec.json @@ -1385,12 +1385,14 @@ "markdownDescription": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate" }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." } }, "additionalProperties": false, @@ -2747,12 +2749,14 @@ "markdownDescription": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate" }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." } }, "additionalProperties": false, @@ -2942,7 +2946,9 @@ "markdownDescription": "Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "starterProjects": { "description": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", @@ -3080,9 +3086,9 @@ "markdownDescription": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." }, "variables": { "description": "Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", diff --git a/schemas/latest/ide-targeted/dev-workspace-template.json b/schemas/latest/ide-targeted/dev-workspace-template.json index 7c9f3be2d..8f2daf3b1 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template.json +++ b/schemas/latest/ide-targeted/dev-workspace-template.json @@ -1583,12 +1583,14 @@ "markdownDescription": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate" }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." } }, "additionalProperties": false, @@ -2945,12 +2947,14 @@ "markdownDescription": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate" }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." } }, "additionalProperties": false, @@ -3140,7 +3144,9 @@ "markdownDescription": "Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "starterProjects": { "description": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", @@ -3278,9 +3284,9 @@ "markdownDescription": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." }, "variables": { "description": "Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", diff --git a/schemas/latest/ide-targeted/dev-workspace.json b/schemas/latest/ide-targeted/dev-workspace.json index 8f032301e..3b9da8435 100644 --- a/schemas/latest/ide-targeted/dev-workspace.json +++ b/schemas/latest/ide-targeted/dev-workspace.json @@ -1596,12 +1596,14 @@ "markdownDescription": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate" }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." } }, "additionalProperties": false, @@ -2958,12 +2960,14 @@ "markdownDescription": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate" }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." } }, "additionalProperties": false, @@ -3153,7 +3157,9 @@ "markdownDescription": "Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "starterProjects": { "description": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", @@ -3291,9 +3297,9 @@ "markdownDescription": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." }, "variables": { "description": "Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", diff --git a/schemas/latest/ide-targeted/devfile.json b/schemas/latest/ide-targeted/devfile.json index 04039a3cf..db0a3a660 100644 --- a/schemas/latest/ide-targeted/devfile.json +++ b/schemas/latest/ide-targeted/devfile.json @@ -1570,7 +1570,9 @@ "markdownDescription": "Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "starterProjects": { "description": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", @@ -1708,9 +1710,9 @@ "markdownDescription": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." }, "variables": { "description": "Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.", diff --git a/schemas/latest/ide-targeted/parent-overrides.json b/schemas/latest/ide-targeted/parent-overrides.json index 0d9ab20d8..a811dd80b 100644 --- a/schemas/latest/ide-targeted/parent-overrides.json +++ b/schemas/latest/ide-targeted/parent-overrides.json @@ -1270,12 +1270,14 @@ "markdownDescription": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate" }, "registryUrl": { - "type": "string" + "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.", + "type": "string", + "markdownDescription": "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." }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string", - "markdownDescription": "Uri of a Devfile yaml file" + "markdownDescription": "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." } }, "additionalProperties": false, diff --git a/schemas/latest/parent-overrides.json b/schemas/latest/parent-overrides.json index 45e078129..2a3b8dfb1 100644 --- a/schemas/latest/parent-overrides.json +++ b/schemas/latest/parent-overrides.json @@ -1142,10 +1142,11 @@ "additionalProperties": false }, "registryUrl": { + "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.", "type": "string" }, "uri": { - "description": "Uri of a Devfile yaml file", + "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.", "type": "string" } },