package kubecaml

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

Status_cause provides more information about an api.status failure, including cases when multiple errors are encountered.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?reason:string -> ?message:string -> ?field:string -> unit -> t
val field : t -> string option

The field of the resource that has caused this error, as named by its Json serialization. May include dot and postfix notation for nested attributes. Arrays are zero_indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"

val message : t -> string option

A human_readable description of the cause of the error. This field may be presented as_is to a reader.

val reason : t -> string option

A machine_readable description of the cause of the error. If this value is empty there is no information available.

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