notes.md

API Reference

Packages:

• notes.miloapis.com/v1alpha1

notes.miloapis.com/v1alpha1

Resource Types:

• Note

• ClusterNote

Note

^{↩ Parent}

Note is the Schema for the notes API. It represents a namespaced note attached to a subject resource.

Name	Type	Description	Required
apiVersion	string	notes.miloapis.com/v1alpha1	true
kind	string	Note	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	NoteSpec defines the desired state of Note.	false
status	object	NoteStatus defines the observed state of Note	false

Note.spec

^{↩ Parent}

NoteSpec defines the desired state of Note.

Name	Type	Description	Required
content	string	Content is the text content of the note. Validations: MaxLength: 1000	true
subjectRef	object	Subject is a reference to the subject of the note. Validations: type(oldSelf) == null_type || self == oldSelf: subject type is immutable	true
creatorRef	object	CreatorRef is a reference to the user that created the note. Defaults to the user that created the note. Validations: type(oldSelf) == null_type || self == oldSelf: creatorRef type is immutable	true
followUp	boolean	FollowUp indicates whether this note requires follow-up. When true, the note is being actively tracked for further action. Default: false	false
interactionTime	string	InteractionTime is the timestamp of the interaction with the subject. Format: date-time	false
nextAction	string	NextAction is an optional follow-up action.	false
nextActionTime	string	NextActionTime is the timestamp for the follow-up action. Format: date-time	false

Note.spec.subjectRef

^{↩ Parent}

Subject is a reference to the subject of the note.

Name	Type	Description	Required
apiGroup	string	APIGroup is the group for the resource being referenced.	true
kind	string	Kind is the type of resource being referenced.	true
name	string	Name is the name of resource being referenced.	true
namespace	string	Namespace is the namespace of resource being referenced. Required for namespace-scoped resources. Omitted for cluster-scoped resources.	false

Note.spec.creatorRef

^{↩ Parent}

CreatorRef is a reference to the user that created the note. Defaults to the user that created the note.

Name	Type	Description	Required
name	string	Name is the name of the User being referenced.	true

Note.status

^{↩ Parent}

NoteStatus defines the observed state of Note

Name	Type	Description	Required
conditions	[]object	Conditions provide conditions that represent the current status of the Note. Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]]	false
createdBy	string	CreatedBy is the email of the user that created the note.	false

Note.status.conditions[index]

^{↩ Parent}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

ClusterNote

^{↩ Parent}

ClusterNote is the Schema for the cluster-scoped notes API. It represents a note attached to a cluster-scoped subject resource.

Name	Type	Description	Required
apiVersion	string	notes.miloapis.com/v1alpha1	true
kind	string	ClusterNote	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	NoteSpec defines the desired state of Note.	false
status	object	NoteStatus defines the observed state of Note	false

ClusterNote.spec

^{↩ Parent}

NoteSpec defines the desired state of Note.

Name	Type	Description	Required
content	string	Content is the text content of the note. Validations: MaxLength: 1000	true
subjectRef	object	Subject is a reference to the subject of the note. Validations: type(oldSelf) == null_type || self == oldSelf: subject type is immutable	true
creatorRef	object	CreatorRef is a reference to the user that created the note. Defaults to the user that created the note. Validations: type(oldSelf) == null_type || self == oldSelf: creatorRef type is immutable	true
followUp	boolean	FollowUp indicates whether this note requires follow-up. When true, the note is being actively tracked for further action. Default: false	false
interactionTime	string	InteractionTime is the timestamp of the interaction with the subject. Format: date-time	false
nextAction	string	NextAction is an optional follow-up action.	false
nextActionTime	string	NextActionTime is the timestamp for the follow-up action. Format: date-time	false

ClusterNote.spec.subjectRef

^{↩ Parent}

Subject is a reference to the subject of the note.

Name	Type	Description	Required
apiGroup	string	APIGroup is the group for the resource being referenced.	true
kind	string	Kind is the type of resource being referenced.	true
name	string	Name is the name of resource being referenced.	true
namespace	string	Namespace is the namespace of resource being referenced. Required for namespace-scoped resources. Omitted for cluster-scoped resources.	false

ClusterNote.spec.creatorRef

^{↩ Parent}

CreatorRef is a reference to the user that created the note. Defaults to the user that created the note.

Name	Type	Description	Required
name	string	Name is the name of the User being referenced.	true

ClusterNote.status

^{↩ Parent}

NoteStatus defines the observed state of Note

Name	Type	Description	Required
conditions	[]object	Conditions provide conditions that represent the current status of the Note. Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]]	false
createdBy	string	CreatedBy is the email of the user that created the note.	false

ClusterNote.status.conditions[index]

^{↩ Parent}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false