package kubecaml

  1. Overview
  2. Docs
package kubecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

Custom_resource_definition_names indicates the names to serve this Custom_resource_definition

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?singular:string -> ?short_names:string list -> plural:string -> ?list_kind:string -> kind:string -> ?categories:string list -> unit -> t
val categories : t -> string list option

Categories is a list of grouped resources custom resources belong to (e.g. 'all')

val kind : t -> string

Kind is the serialized kind of the resource. It is normally CamelCase and singular.

val list_kind : t -> string option

List_kind is the serialized kind of the list for this resource. Defaults to <kind>list.

val plural : t -> string

Plural is the plural name of the resource to serve. It must match the name of the Custom_resource_definition_registration too: plural.group and it must be all lowercase.

val short_names : t -> string list option

Short_names are short names for the resource. It must be all lowercase.

val singular : t -> string option

Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind>

module Object : Object.S with type value := t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events Blog Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct