Do not add the description tag to any new API fields. All
descriptions should follow the upstream conventions as Godoc on public
API fields, i.e.:
// Protocol for port. Must be UDP or TCP.
// Defaults to "TCP".
Protocol Protocol `json:"protocol,omitempty"`
Note that the Godoc for api fields does not have to start with the
name of the field.
All top level API resources should have Godoc:
// Service is a named abstraction of software service (for
example, mysql) consisting of local port
// (for example 3306) that the proxy listens on, and the selector
that determines which pods
// will answer requests sent through the proxy.
type Service struct {
Done right, this will end up in `oc explain`:
$ oc explain service
DESCRIPTION:
Service is a named abstraction of software service (for example,
mysql) consisting of local port (for example 3306) that the proxy
listens on, and the selector that determines which pods will answer
requests sent through the proxy.
FIELDS:
status <Object>
Most recently observed status of the service. Populated by the system.
Read-only. More info:
http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
_______________________________________________
dev mailing list
[email protected]
http://lists.openshift.redhat.com/openshiftmm/listinfo/dev
