Skip to content

Commit

Permalink
Remove description field from types
Browse files Browse the repository at this point in the history
  • Loading branch information
mfojtik authored and deads2k committed Oct 27, 2017
1 parent 98e2f70 commit fa9c2cc
Show file tree
Hide file tree
Showing 10 changed files with 408 additions and 408 deletions.
126 changes: 63 additions & 63 deletions pkg/authorization/api/v1/types.go

Large diffs are not rendered by default.

232 changes: 116 additions & 116 deletions pkg/build/api/v1/types.go

Large diffs are not rendered by default.

138 changes: 69 additions & 69 deletions pkg/deploy/api/v1/types.go

Large diffs are not rendered by default.

132 changes: 66 additions & 66 deletions pkg/image/api/v1/types.go

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions pkg/oauth/api/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,28 @@ type OAuthAccessToken struct {
kapi.ObjectMeta `json:"metadata,omitempty"`

// ClientName references the client that created this token.
ClientName string `json:"clientName,omitempty" description:"references the client that created this token"`
ClientName string `json:"clientName,omitempty"`

// ExpiresIn is the seconds from CreationTime before this token expires.
ExpiresIn int64 `json:"expiresIn,omitempty" description:"is the seconds from creation time before this token expires"`
ExpiresIn int64 `json:"expiresIn,omitempty"`

// Scopes is an array of the requested scopes.
Scopes []string `json:"scopes,omitempty" description:"list of requested scopes"`
Scopes []string `json:"scopes,omitempty"`

// RedirectURI is the redirection associated with the token.
RedirectURI string `json:"redirectURI,omitempty" description:"redirection URI associated with the token"`
RedirectURI string `json:"redirectURI,omitempty"`

// UserName is the user name associated with this token
UserName string `json:"userName,omitempty" description:"user name associated with this token"`
UserName string `json:"userName,omitempty"`

// UserUID is the unique UID associated with this token
UserUID string `json:"userUID,omitempty" description:"unique UID associated with this token"`
UserUID string `json:"userUID,omitempty"`

// AuthorizeToken contains the token that authorized this token
AuthorizeToken string `json:"authorizeToken,omitempty" description:"contains the token that authorized this token"`
AuthorizeToken string `json:"authorizeToken,omitempty"`

// RefreshToken is the value by which this token can be renewed. Can be blank.
RefreshToken string `json:"refreshToken,omitempty" description:"optional value by which this token can be renewed"`
RefreshToken string `json:"refreshToken,omitempty"`
}

// OAuthAuthorizeToken describes an OAuth authorization token
Expand All @@ -43,26 +43,26 @@ type OAuthAuthorizeToken struct {
kapi.ObjectMeta `json:"metadata,omitempty"`

// ClientName references the client that created this token.
ClientName string `json:"clientName,omitempty" description:"references the client that created this token"`
ClientName string `json:"clientName,omitempty"`

// ExpiresIn is the seconds from CreationTime before this token expires.
ExpiresIn int64 `json:"expiresIn,omitempty" description:"seconds from creation time before this token expires"`
ExpiresIn int64 `json:"expiresIn,omitempty"`

// Scopes is an array of the requested scopes.
Scopes []string `json:"scopes,omitempty" description:"list of requested scopes"`
Scopes []string `json:"scopes,omitempty"`

// RedirectURI is the redirection associated with the token.
RedirectURI string `json:"redirectURI,omitempty" description:"redirection URI associated with the token"`
RedirectURI string `json:"redirectURI,omitempty"`

// State data from request
State string `json:"state,omitempty" description:"state data from request"`
State string `json:"state,omitempty"`

// UserName is the user name associated with this token
UserName string `json:"userName,omitempty" description:"user name associated with this token"`
UserName string `json:"userName,omitempty"`

// UserUID is the unique UID associated with this token. UserUID and UserName must both match
// for this token to be valid.
UserUID string `json:"userUID,omitempty" description:"unique UID associated with this token. userUID and userName must both match for this token to be valid"`
UserUID string `json:"userUID,omitempty"`
}

// OAuthClient describes an OAuth client
Expand All @@ -72,13 +72,13 @@ type OAuthClient struct {
kapi.ObjectMeta `json:"metadata,omitempty"`

// Secret is the unique secret associated with a client
Secret string `json:"secret,omitempty" description:"unique secret associated with a client"`
Secret string `json:"secret,omitempty"`

// RespondWithChallenges indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects
RespondWithChallenges bool `json:"respondWithChallenges,omitempty" description:"indicates whether the client wants authentication needed responses made in the form of challenges instead of redirects"`
RespondWithChallenges bool `json:"respondWithChallenges,omitempty"`

// RedirectURIs is the valid redirection URIs associated with a client
RedirectURIs []string `json:"redirectURIs,omitempty" description:"valid redirection URIs associated with a client"`
RedirectURIs []string `json:"redirectURIs,omitempty"`
}

// OAuthClientAuthorization describes an authorization created by an OAuth client
Expand All @@ -88,17 +88,17 @@ type OAuthClientAuthorization struct {
kapi.ObjectMeta `json:"metadata,omitempty"`

// ClientName references the client that created this authorization
ClientName string `json:"clientName,omitempty" description:"references the client that created this authorization"`
ClientName string `json:"clientName,omitempty"`

// UserName is the user name that authorized this client
UserName string `json:"userName,omitempty" description:"user name that authorized this client"`
UserName string `json:"userName,omitempty"`

// UserUID is the unique UID associated with this authorization. UserUID and UserName
// must both match for this authorization to be valid.
UserUID string `json:"userUID,omitempty" description:"unique UID associated with this authorization. userUID and userName must both match for this authorization to be valid"`
UserUID string `json:"userUID,omitempty"`

// Scopes is an array of the granted scopes.
Scopes []string `json:"scopes,omitempty" description:"list of granted scopes"`
Scopes []string `json:"scopes,omitempty"`
}

// OAuthAccessTokenList is a collection of OAuth access tokens
Expand All @@ -107,7 +107,7 @@ type OAuthAccessTokenList struct {
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is the list of OAuth access tokens
Items []OAuthAccessToken `json:"items" description:"list of oauth access tokens"`
Items []OAuthAccessToken `json:"items"`
}

// OAuthAuthorizeTokenList is a collection of OAuth authorization tokens
Expand All @@ -116,7 +116,7 @@ type OAuthAuthorizeTokenList struct {
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is the list of OAuth authorization tokens
Items []OAuthAuthorizeToken `json:"items" description:"list of oauth authorization tokens"`
Items []OAuthAuthorizeToken `json:"items"`
}

// OAuthClientList is a collection of OAuth clients
Expand All @@ -125,7 +125,7 @@ type OAuthClientList struct {
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is the list of OAuth clients
Items []OAuthClient `json:"items" description:"list of oauth clients"`
Items []OAuthClient `json:"items"`
}

// OAuthClientAuthorizationList is a collection of OAuth client authorizations
Expand All @@ -134,5 +134,5 @@ type OAuthClientAuthorizationList struct {
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is the list of OAuth client authorizations
Items []OAuthClientAuthorization `json:"items" description:"list of oauth client authorizations"`
Items []OAuthClientAuthorization `json:"items"`
}
14 changes: 7 additions & 7 deletions pkg/project/api/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ type ProjectList struct {
// Standard object's metadata.
unversioned.ListMeta `json:"metadata,omitempty"`
// Items is the list of projects
Items []Project `json:"items" description:"list of projects"`
Items []Project `json:"items"`
}

const (
Expand All @@ -22,13 +22,13 @@ const (
// ProjectSpec describes the attributes on a Project
type ProjectSpec struct {
// Finalizers is an opaque list of values that must be empty to permanently remove object from storage
Finalizers []kapi.FinalizerName `json:"finalizers,omitempty" description:"an opaque list of values that must be empty to permanently remove object from storage"`
Finalizers []kapi.FinalizerName `json:"finalizers,omitempty"`
}

// ProjectStatus is information about the current status of a Project
type ProjectStatus struct {
// Phase is the current lifecycle phase of the project
Phase kapi.NamespacePhase `json:"phase,omitempty" description:"phase is the current lifecycle phase of the project"`
Phase kapi.NamespacePhase `json:"phase,omitempty"`
}

// Project is a logical top-level container for a set of origin resources
Expand All @@ -38,10 +38,10 @@ type Project struct {
kapi.ObjectMeta `json:"metadata,omitempty"`

// Spec defines the behavior of the Namespace.
Spec ProjectSpec `json:"spec,omitempty" description:"spec defines the behavior of the Project"`
Spec ProjectSpec `json:"spec,omitempty"`

// Status describes the current status of a Namespace
Status ProjectStatus `json:"status,omitempty" description:"status describes the current status of a Project; read-only"`
Status ProjectStatus `json:"status,omitempty"`
}

// ProjecRequest is the set of options necessary to fully qualify a project request
Expand All @@ -50,7 +50,7 @@ type ProjectRequest struct {
// Standard object's metadata.
kapi.ObjectMeta `json:"metadata,omitempty"`
// DisplayName is the display name to apply to a project
DisplayName string `json:"displayName,omitempty" description:"display name to apply to a project"`
DisplayName string `json:"displayName,omitempty"`
// Description is the description to apply to a project
Description string `json:"description,omitempty" description:"description to apply to a project"`
Description string `json:"description,omitempty"`
}
52 changes: 26 additions & 26 deletions pkg/route/api/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ type Route struct {
kapi.ObjectMeta `json:"metadata,omitempty"`

// Spec is the desired state of the route
Spec RouteSpec `json:"spec" description:"desired state of the route"`
Spec RouteSpec `json:"spec"`
// Status is the current state of the route
Status RouteStatus `json:"status" description:"current state of the route"`
Status RouteStatus `json:"status"`
}

// RouteList is a collection of Routes.
Expand All @@ -25,7 +25,7 @@ type RouteList struct {
unversioned.ListMeta `json:"metadata,omitempty"`

// Items is a list of routes
Items []Route `json:"items" description:"list of routes"`
Items []Route `json:"items"`
}

// RouteSpec describes the route the user wishes to exist.
Expand All @@ -35,29 +35,29 @@ type RouteSpec struct {

// Host is an alias/DNS that points to the service. Optional
// Must follow DNS952 subdomain conventions.
Host string `json:"host" description:"optional: alias/dns that points to the service, must follow DNS 952 subdomain conventions"`
Host string `json:"host"`
// Path that the router watches for, to route traffic for to the service. Optional
Path string `json:"path,omitempty" description:"optional: path that the router watches to route traffic to the service"`
Path string `json:"path,omitempty"`

// To is an object the route points to. Only the Service kind is allowed, and it will
// be defaulted to Service.
To kapi.ObjectReference `json:"to" description:"an object the route points to. only the service kind is allowed, and it will be defaulted to a service."`
To kapi.ObjectReference `json:"to"`

// If specified, the port to be used by the router. Most routers will use all
// endpoints exposed by the service by default - set this value to instruct routers
// which port to use.
Port *RoutePort `json:"port,omitempty" description:"port that should be used by the router; this is a hint to control which pod endpoint port is used; if empty routers may use all endpoints and ports"`
Port *RoutePort `json:"port,omitempty"`

// TLS provides the ability to configure certificates and termination for the route
TLS *TLSConfig `json:"tls,omitempty" description:"provides the ability to configure certificates and termination for the route"`
TLS *TLSConfig `json:"tls,omitempty"`
}

// RoutePort defines a port mapping from a router to an endpoint in the service endpoints.
type RoutePort struct {
// The target port on pods selected by the service this route points to.
// If this is a string, it will be looked up as a named port in the target
// endpoints port list. Required
TargetPort intstr.IntOrString `json:"targetPort" description:"the target port on the endpoints for the service; if this is a string must match the named port, if an integer, must match the port number"`
TargetPort intstr.IntOrString `json:"targetPort"`
}

// RouteStatus provides relevant info about the status of a route, including which routers
Expand All @@ -66,17 +66,17 @@ type RouteStatus struct {
// Ingress describes the places where the route may be exposed. The list of
// ingress points may contain duplicate Host or RouterName values. Routes
// are considered live once they are `Ready`
Ingress []RouteIngress `json:"ingress" description:"traffic reaches this route via these ingress paths"`
Ingress []RouteIngress `json:"ingress"`
}

// RouteIngress holds information about the places where a route is exposed
type RouteIngress struct {
// Host is the host string under which the route is exposed; this value is required
Host string `json:"host,omitempty" description:"the host name this route is exposed to by the specified router"`
Host string `json:"host,omitempty"`
// Name is a name chosen by the router to identify itself; this value is required
RouterName string `json:"routerName,omitempty" description:"the name of the router exposing this route"`
RouterName string `json:"routerName,omitempty"`
// Conditions is the state of the route, may be empty.
Conditions []RouteIngressCondition `json:"conditions,omitempty" description:"the conditions that apply to this router" patchStrategy:"merge" patchMergeKey:"type"`
Conditions []RouteIngressCondition `json:"conditions,omitempty"`
}

// RouteIngressConditionType is a valid value for RouteCondition
Expand All @@ -94,17 +94,17 @@ const (
type RouteIngressCondition struct {
// Type is the type of the condition.
// Currently only Ready.
Type RouteIngressConditionType `json:"type" description:"the type of the condition"`
Type RouteIngressConditionType `json:"type"`
// Status is the status of the condition.
// Can be True, False, Unknown.
Status kapi.ConditionStatus `json:"status" description:"status is the status of the condition; True, False, or Unknown"`
Status kapi.ConditionStatus `json:"status"`
// (brief) reason for the condition's last transition, and is usually a machine and human
// readable constant
Reason string `json:"reason,omitempty" description:"brief reason for the condition's last transition, machine readable constant"`
Reason string `json:"reason,omitempty"`
// Human readable message indicating details about last transition.
Message string `json:"message,omitempty" description:"human readable message indicating details about this condition"`
Message string `json:"message,omitempty"`
// RFC 3339 date and time when this condition last transitioned
LastTransitionTime *unversioned.Time `json:"lastTransitionTime,omitempty" description:"the last time at which this condition transitioned to the current status"`
LastTransitionTime *unversioned.Time `json:"lastTransitionTime,omitempty"`
}

// RouterShard has information of a routing shard and is used to
Expand All @@ -115,34 +115,34 @@ type RouteIngressCondition struct {
type RouterShard struct {
// ShardName uniquely identifies a router shard in the "set" of
// routers used for routing traffic to the services.
ShardName string `json:"shardName" description:"uniquely identifies a router shard in the set of routers used for routing traffic to the services"`
ShardName string `json:"shardName"`

// DNSSuffix for the shard ala: shard-1.v3.openshift.com
DNSSuffix string `json:"dnsSuffix" description:"DNS suffix for the shard (i.e. shard-1.v3.openshift.com)"`
DNSSuffix string `json:"dnsSuffix"`
}

// TLSConfig defines config used to secure a route and provide termination
type TLSConfig struct {
// Termination indicates termination type.
Termination TLSTerminationType `json:"termination" description:"indicates termination type"`
Termination TLSTerminationType `json:"termination"`

// Certificate provides certificate contents
Certificate string `json:"certificate,omitempty" description:"provides certificate contents"`
Certificate string `json:"certificate,omitempty"`

// Key provides key file contents
Key string `json:"key,omitempty" description:"provides key file contents"`
Key string `json:"key,omitempty"`

// CACertificate provides the cert authority certificate contents
CACertificate string `json:"caCertificate,omitempty" description:"provides the cert authority certificate contents"`
CACertificate string `json:"caCertificate,omitempty"`

// DestinationCACertificate provides the contents of the ca certificate of the final destination. When using reencrypt
// termination this file should be provided in order to have routers use it for health checks on the secure connection
DestinationCACertificate string `json:"destinationCACertificate,omitempty" description:"provides the contents of the ca certificate of the final destination. When using re-encrypt termination this file should be provided in order to have routers use it for health checks on the secure connection"`
DestinationCACertificate string `json:"destinationCACertificate,omitempty"`

// InsecureEdgeTerminationPolicy indicates the desired behavior for
// insecure connections to an edge-terminated route:
// disable, allow or redirect
InsecureEdgeTerminationPolicy InsecureEdgeTerminationPolicyType `json:"insecureEdgeTerminationPolicy,omitempty" description:"indicates desired behavior for insecure connections to an edge-terminated route. If not set, insecure connections will not be allowed"`
InsecureEdgeTerminationPolicy InsecureEdgeTerminationPolicyType `json:"insecureEdgeTerminationPolicy,omitempty"`
}

// TLSTerminationType dictates where the secure communication will stop
Expand Down
Loading

0 comments on commit fa9c2cc

Please sign in to comment.