Skip to content

Commit 42f533b

Browse files
committedJan 29, 2019
move annotation constants into api
1 parent 6771530 commit 42f533b

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed
 

‎annotations/annotations.go

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
package annotations
2+
3+
// annotation keys
4+
// NEVER ADD TO THIS LIST. Annotations need to be owned in the API groups they are associated with, so these constants end
5+
// up nested in an API group, not top level in the OpenShift namespace. The items located here are examples of annotations
6+
// claiming a global namespace key that have never achieved global reach. In the future, names should be based on the
7+
// consuming component.
8+
const (
9+
// OpenShiftDisplayName is a common, optional annotation that stores the name displayed by a UI when referencing a resource.
10+
OpenShiftDisplayName = "openshift.io/display-name"
11+
12+
// OpenShiftProviderDisplayNameAnnotation is the name of a provider of a resource, e.g.
13+
// "Red Hat, Inc."
14+
OpenShiftProviderDisplayNameAnnotation = "openshift.io/provider-display-name"
15+
16+
// OpenShiftDocumentationURLAnnotation is the url where documentation associated with
17+
// a resource can be found.
18+
OpenShiftDocumentationURLAnnotation = "openshift.io/documentation-url"
19+
20+
// OpenShiftSupportURLAnnotation is the url where support for a template can be found.
21+
OpenShiftSupportURLAnnotation = "openshift.io/support-url"
22+
23+
// OpenShiftDescription is a common, optional annotation that stores the description for a resource.
24+
OpenShiftDescription = "openshift.io/description"
25+
26+
// OpenShiftLongDescriptionAnnotation is a resource's long description
27+
OpenShiftLongDescriptionAnnotation = "openshift.io/long-description"
28+
)

0 commit comments

Comments
 (0)
Please sign in to comment.