v1alpha1

type Direction string

type GroupQuery struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec     *QuerySpec     `json:"spec,omitempty"`
	Response *QueryResponse `json:"response,omitempty"`
}

type JSON struct {
	Object interface{} `json:"-"`
}

type JSONObject struct {
	Object map[string]interface{} `json:"-"`
}

type Query struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec     *QuerySpec     `json:"spec,omitempty"`
	Response *QueryResponse `json:"response,omitempty"`
}

type QueryCondition struct {
	// type is the type of condition to query.
	// Examples: Ready, Synced
	//
	// +kubebuilder:validation:Required
	Type string `json:"type"`
	// status is the status of condition to query. This is either True, False
	// or Unknown.
	//
	// +kubebuilder:validation:Required
	Status string `json:"status"`
}

type QueryFilter struct {
	// namespace is the namespace WITHIN a controlplane to query. If empty,
	// all namespaces are queried in the given scope.
	Namespace string `json:"namespace,omitempty"`
	// name is the name of the object to query. If empty, all objects are queried
	// in the given scope.
	Name string `json:"name,omitempty"`
	// group is the API group to query. If empty, all groups are queried in the
	// given scope.
	Group string `json:"group,omitempty"`
	// kind is the API kind to query. If empty, all kinds are queried in the
	// given scope. The kind is case-insensitive. The kind also matches plural
	// resources.
	Kind string `json:"kind,omitempty"`
	// categories is a list of categories to query. If empty, all categories are
	// queried in the given scope.
	// Examples: all, managed, composite, claim
	Categories []string `json:"categories,omitempty"`
	// conditions is a list of conditions to query. If empty, all conditions are
	// queried in the given scope.
	Conditions []QueryCondition `json:"conditions,omitempty"`
	// owners is a list of owners to query. An object matches if it has at least
	// one owner in the list.
	Owners []QueryOwner `json:"owners,omitempty"`
	// sql is a SQL query to query. If empty, all objects are queried in the
	// given scope.
	//
	// The current object can be referenced by the alias "o".
	//
	// WARNING: The where clause is highly dependent on the database
	// schema and might change at any time. The schema is not documented.
	SQL string `json:"sql,omitempty"`
}

type QueryFilterControlPlane struct {
	// name is the name of the controlplane to query. If empty, all controlplanes
	// are queried in the given scope.
	Name string `json:"name,omitempty"`
	// namespace is the namespace of the controlplane to query. If empty, all
	// namespaces are queried in the given scope.
	Namespace string `json:"namespace,omitempty"`
}

type QueryNestedResources struct {
	QueryResources `json:",inline"`

	// filter specifies how to filter the returned objects.
	Filter QueryFilter `json:"filter,omitempty"`
}

type QueryObjects struct {
	// id specifies whether to return the id of the object. The id is opaque,
	// i.e. the format is undefined. It's only valid for comparison within the
	// response and as part of the spec.ids field in immediately following queries.
	// The format of the id might change between releases.
	ID bool `json:"id,omitempty"`

	// mutablePath specifies whether to return the mutable path of the object,
	// i.e. the path to the object in the controlplane Kubernetes API.
	MutablePath bool `json:"mutablePath,omitempty"`

	// controlPlane specifies that the controlplane name and namespace of the
	// object should be returned.
	ControlPlane bool `json:"controlPlane,omitempty"`

	// object specifies how to return the object, i.e. a sparse skeleton of
	// fields. A value of true means that all descendants of that field should
	// be returned. Other primitive values are not allowed. If the type of
	// a field does not match the schema (e.g. an array instead of an object),
	// the field is ignored.
	//
	// +kubebuilder:validation:Schemaless
	// +kubebuilder:pruning:PreserveUnknownFields
	Object *JSON `json:"object,omitempty"`

	// relations specifies which relations to query and what to return.
	// Relation names are predefined strings relative to the release of
	// Spaces.
	//
	// Examples: owners, descendants, resources, events, or their transitive
	// equivalents owners+, descendants+, resources+.
	Relations map[string]QueryRelation `json:"relations,omitempty"`
}

type QueryOrder struct {
	// creationTimestamp specifies how to order by creation timestamp.
	//
	// +kubebuilder:validation:Enum=Asc;Desc
	CreationTimestamp Direction `json:"creationTimestamp,omitempty"`

	// name specifies how to order by name.
	//
	// +kubebuilder:validation:Enum=Asc;Desc
	Name Direction `json:"name,omitempty"`

	// namespace specifies how to order by namespace.
	//
	// +kubebuilder:validation:Enum=Asc;Desc
	Namespace Direction `json:"namespace,omitempty"`

	// kind specifies how to order by kind.
	//
	// +kubebuilder:validation:Enum=Asc;Desc
	Kind Direction `json:"kind,omitempty"`

	// group specifies how to order by group.
	//
	// +kubebuilder:validation:Enum=Asc;Desc
	Group Direction `json:"group,omitempty"`

	// controlPlane specifies how to order by controlplane.
	ControlPlane Direction `json:"cluster"`
}

type QueryOwner struct {
	// name is the name of the owner to match.
	Group string `json:"group,omitempty"`
	// kind is the kind of the owner to match.
	Kind string `json:"kind,omitempty"`
	// uid is the uid of the owner to match.
	UID string `json:"uid,omitempty"`
}

type QueryPage struct {
	// first is the number of the first object to return relative to the cursor.
	// If neither first nor cursor is specified, objects are returned from the
	// beginning.
	First int `json:"first,omitempty"`
	// cursor is the cursor of the first object to return. This value is opaque,
	// the format cannot be relied on. It is returned by the server in the
	// response to a previous query. If neither first nor cursor is specified,
	// objects are returned from the beginning.
	//
	// Note that cursor values are not stable under different orderings.
	Cursor string `json:"cursor,omitempty"`
}

type QueryRelation struct {
	QueryNestedResources `json:",inline"`
}

type QueryResources struct {
	// count specifies whether to return the number of objects. Note that
	// computing the count is expensive and should only be done if necessary.
	// Count is the remaining objects that match the query after paging.
	Count bool `json:"count,omitempty"`

	// objects specifies how to return the objects.
	Objects *QueryObjects `json:"objects,omitempty"`

	// order specifies how to order the returned objects. The first element
	// specifies the primary order, the second element specifies the secondary,
	// etc.
	Order []QueryOrder `json:"order,omitempty"`

	// limit is the maximal number of objects to return. Defaulted to 100.
	//
	// Note that a limit in a relation subsumes all the children of all parents,
	// i.e. a small limit only makes sense if there is only a single parent,
	// e.g. selected via spec.IDs.
	Limit int `json:"limit,omitempty"`

	// Page specifies how to page the returned objects.
	Page QueryPage `json:"page,omitempty"`

	// Cursor specifies the cursor of the first object to return. This value is
	// opaque and is only valid when passed into spec.page.cursor in a subsequent
	// query. The format of the cursor might change between releases.
	Cursor bool `json:"cursor,omitempty"`
}

type QueryResponse struct {
	// warnings is a list of warnings that occurred while processing the query.
	// The query is still executed, but these warnings indicate problems. It
	// is recommended to print these to the user.
	Warnings []string `json:"warnings,omitempty"`

	QueryResponseObjects `json:",inline"`
}

type QueryResponseControlPlane struct {
	// name is the name of the controlplane of the object.
	Name string `json:"name,omitempty"`
	// namespace is the namespace of the controlplane of the object.
	Namespace string `json:"namespace,omitempty"`
}

type QueryResponseCursor struct {
	// cursor is the cursor to the next page of results. If empty, there are no more,
	Next string `json:"next"`
	// page is the page number of the cursor.
	Page int `json:"page"`
	// pageSize is the number of objects per page, i.e. the limit of the query.
	PageSize int `json:"pageSize"`
	// position is the position of the first object in the list of matching objects
	// at the time the first cursor was created. Due to creation and deletion of
	// objects before the cursor this value might be outdated.
	Position int `json:"position"`
}

type QueryResponseMutablePath struct {
	// basePath is the base URL of the controlplane, i.e. the Kubernetes API
	// endpoint.
	BasePath string `json:"basePath,omitempty"`

	metav1.GroupVersionResource `json:",inline"`
}

type QueryResponseObject struct {
	// id indentifies the object. The id is opaque, i.e. the format is
	// undefined. It's only valid for comparison within the response and as part
	// of the spec.ids field in immediately following queries. The format of the
	// id might change between releases.
	ID string `json:"id,omitempty"`

	// mutablePath is the mutable path of the object, i.e. the path to the
	// object in the controlplane Kubernetes API.
	MutablePath *QueryResponseMutablePath `json:"mutablePath,omitempty"`

	// controlPlane is the name and namespace of the object.
	ControlPlane *QueryResponseControlPlane `json:"controlPlane,omitempty"`

	// object is the sparse representation of the object.
	Object *JSONObject `json:"object,omitempty"`

	// errors is the list of errors that occurred while processing the object.
	Errors []string `json:"$errors,omitempty"`

	// relations is the list of objects related to the object.
	Relations map[string]QueryResponseRelation `json:"relations,omitempty"`
}

type QueryResponseObjects struct {
	// cursor is cursor to the next page of results.
	Cursor *QueryResponseCursor `json:"cursor,omitempty"`

	// objects is the list of objects returned by the query.
	Objects []QueryResponseObject `json:"objects,omitempty"`

	// count is the total number of objects that match the query.
	Count *int `json:"count,omitempty"`

	// incomplete is true if the query was (potentially) limited before all
	// matching objects. If a non-empty spec.page.cursor has been used, or
	// objects have been skipped through non-zero spec.page.first, this value
	// is always true.
	Incomplete bool `json:"incomplete,omitempty"`
}

type QueryResponseRelation struct {
	QueryResponseObjects `json:",inline"`
}

type QuerySpec struct {
	QueryTopLevelResources `json:",inline"`
}

type QueryTopLevelFilter struct {
	// controlPlane specifies which controlplanes to query. If empty, all
	// controlplanes are queried in the given scope.
	ControlPlane QueryFilterControlPlane `json:"controlPlane,omitempty"`

	//	# ids: ["id1","id2"] # to get objects explicitly by id.
	IDs []string `json:"ids,omitempty"`

	QueryFilter `json:",inline"`
}

type QueryTopLevelResources struct {
	QueryResources `json:",inline"`

	// filter specifies how to filter the returned objects.
	Filter QueryTopLevelFilter `json:"filter,omitempty"`
}

type SpaceQuery struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec     *QuerySpec     `json:"spec,omitempty"`
	Response *QueryResponse `json:"response,omitempty"`
}