Skip to content

Commit b22d4e6

Browse files
committed
enhancements/update/available-update-metadata: 'url' docstring context
Fixups to 2eb16cf (enhancements/update/available-update-metadata: Propose a new enhancement, 2019-11-19, openshift#123): * Including two sentences from Clayton about how the CVO sources this information and how we build CI/nightly images [1,2]. I think these two sentences are poking holes in the abstraction that the CVO is committing to with the new API, and that consumers should not have to know or care about these implementation details. Clayton feels like they provide useful context about how the system works, and that we'll adjust them as necessary if we ever have cause to alter the implementation. * Downcasing in the Go comments, to match the JSON property, following the Kubernetes API pattern. * 'despire' -> 'despite' typo fix. [1]: openshift/api#521 (comment) [2]: openshift/api#521 (comment)
1 parent d38ee88 commit b22d4e6

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

enhancements/update/available-update-metadata.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ reviewers:
77
- "@LalatenduMohanty"
88
- "@smarterclayton"
99
approvers:
10-
- TBD
10+
- "@LalatenduMohanty"
11+
- "@sdodson"
12+
- "@smarterclayton"
1113
creation-date: 2019-11-19
12-
last-updated: 2020-07-20
14+
last-updated: 2020-07-21
1315
status: implementable
1416
---
1517

@@ -71,15 +73,17 @@ type Release struct {
7173
// +required
7274
Image string `json:"image"`
7375

74-
// URL describes the contents of this release and will include
75-
// references to other resources as necessary. Go here if you know
76+
// url describes the contents of this release and will include
77+
// references to other resources as necessary. Go here if you know
7678
// of no more-specific resource addressing your question for this
77-
// release image. For example, this could link errata or other
78-
// release notes describing the release image.
79+
// release image. This URL is set by the 'url' metadata property on
80+
// a release or the metadata returned by the update API and should be
81+
// displayed as a link in user interfaces. The URL field may not be set
82+
// for test or nightly releases.
7983
// +optional
8084
URL URL `json:"url,omitempty"`
8185

82-
// Channels is the set of Cincinnati channels to which the release
86+
// channels is the set of Cincinnati channels to which the release
8387
// currently belongs.
8488
// +optional
8589
Channels []string `json:"channels,omitempty"`
@@ -196,7 +200,7 @@ The pushback seems to revolve around a belief that domains, organizations, proje
196200
I think the homepage semantics can apply clearly to any noun, including releases as well as domains, organizations, etc.
197201
But I am comfortable with `url` as long as the declared semantics are "the most generic URI still scoped to this release", and that's what we have here via the "if you know of no more-specific resource" wording.
198202

199-
And then `url` instead of `uri` because Kubernetes APIs have lots of URL precedent, despire RFC 3986's URIs making [the location vs. identifier distinction][rfc-3986-s1.1.3] in 2005.
203+
And then `url` instead of `uri` because Kubernetes APIs have lots of URL precedent, despite RFC 3986's URIs making [the location vs. identifier distinction][rfc-3986-s1.1.3] in 2005.
200204

201205
### Pass-through metadata maps
202206

0 commit comments

Comments
 (0)