Skip to content

update the description of uri to make it more clear #387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 4, 2021
Merged

update the description of uri to make it more clear #387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c170644
rebase master, and update description to registryURL
yangcao77 Apr 27, 2021
925d481
Merge branch 'main' of github.com:devfile/api into update-uri-descrip…
yangcao77 Apr 29, 2021
cc6cc7f
update description
yangcao77 Apr 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions crds/workspace.devfile.io_devworkspaces.v1beta1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
28 changes: 25 additions & 3 deletions crds/workspace.devfile.io_devworkspaces.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
27 changes: 24 additions & 3 deletions crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
27 changes: 24 additions & 3 deletions crds/workspace.devfile.io_devworkspacetemplates.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
7 changes: 6 additions & 1 deletion pkg/apis/workspaces/v1alpha2/import_reference.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"`

Expand All @@ -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"`
}
6 changes: 5 additions & 1 deletion pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions schemas/latest/dev-workspace-template-spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
9 changes: 6 additions & 3 deletions schemas/latest/dev-workspace-template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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"
}
},
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
Loading