Dhall.Kubernetes.Types

Documentation

type Expr = Expr Src Import

type DuplicateHandler = (Text, [ModelName]) -> Maybe ModelName

type Prefix = Text

type ModelHierarchy = [ModelName]

data Swagger

Type for the Swagger specification.

There is such a type defined in the swagger2 package, but Kubernetes' OpenAPI file doesn't conform to that, so here we implement a small version of that tailored to our needs.

Constructors

Swagger

Fields

• definitions :: Map ModelName Definition

Instances

Show Swagger

Defined in Dhall.Kubernetes.Types

Methods

showsPrec :: Int -> Swagger -> ShowS

show :: Swagger -> String

showList :: [Swagger] -> ShowS

Generic Swagger

Defined in Dhall.Kubernetes.Types

Associated Types

type Rep Swagger :: Type -> Type

Methods

from :: Swagger -> Rep Swagger x

to :: Rep Swagger x -> Swagger

FromJSON Swagger

Defined in Dhall.Kubernetes.Types

Methods

parseJSON :: Value -> Parser Swagger

parseJSONList :: Value -> Parser [Swagger]

type Rep Swagger

Defined in Dhall.Kubernetes.Types

type Rep Swagger = D1 ('MetaData "Swagger" "Dhall.Kubernetes.Types" "dhall-openapi-1.0.0-KLOyMybef0aKROwSDb8K2s" 'False) (C1 ('MetaCons "Swagger" 'PrefixI 'True) (S1 ('MetaSel ('Just "definitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ModelName Definition))))

data Definition

Constructors

Definition

Fields

• typ :: Maybe Text
• ref :: Maybe Ref
• format :: Maybe Text
• minimum_ :: Maybe Scientific
• exclusiveMinimum :: Maybe Bool
• description :: Maybe Text
• items :: Maybe Definition
• properties :: Maybe (Map ModelName Definition)
• required :: Maybe (Set FieldName)
• baseData :: Maybe BaseData
• intOrString :: Maybe Bool

Instances

Eq Definition

Defined in Dhall.Kubernetes.Types

Methods

(==) :: Definition -> Definition -> Bool

(/=) :: Definition -> Definition -> Bool

Show Definition

Defined in Dhall.Kubernetes.Types

Methods

showsPrec :: Int -> Definition -> ShowS

show :: Definition -> String

showList :: [Definition] -> ShowS

Generic Definition

Defined in Dhall.Kubernetes.Types

Associated Types

type Rep Definition :: Type -> Type

Methods

from :: Definition -> Rep Definition x

to :: Rep Definition x -> Definition

FromJSON Definition

Defined in Dhall.Kubernetes.Types

Methods

parseJSON :: Value -> Parser Definition

parseJSONList :: Value -> Parser [Definition]

type Rep Definition

Defined in Dhall.Kubernetes.Types

type Rep Definition = D1 ('MetaData "Definition" "Dhall.Kubernetes.Types" "dhall-openapi-1.0.0-KLOyMybef0aKROwSDb8K2s" 'False) (C1 ('MetaCons "Definition" 'PrefixI 'True) (((S1 ('MetaSel ('Just "typ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ref") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Ref))) :*: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "minimum_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Scientific)) :*: S1 ('MetaSel ('Just "exclusiveMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Definition)) :*: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map ModelName Definition))))) :*: (S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Set FieldName))) :*: (S1 ('MetaSel ('Just "baseData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BaseData)) :*: S1 ('MetaSel ('Just "intOrString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))))

newtype Ref

Constructors

Ref

Fields

• unRef :: Text

Instances

Eq Ref

Defined in Dhall.Kubernetes.Types

Methods

(==) :: Ref -> Ref -> Bool

(/=) :: Ref -> Ref -> Bool

Show Ref

Defined in Dhall.Kubernetes.Types

Methods

showsPrec :: Int -> Ref -> ShowS

show :: Ref -> String

showList :: [Ref] -> ShowS

Generic Ref

Defined in Dhall.Kubernetes.Types

Associated Types

type Rep Ref :: Type -> Type

Methods

from :: Ref -> Rep Ref x

to :: Rep Ref x -> Ref

FromJSON Ref

Defined in Dhall.Kubernetes.Types

Methods

parseJSON :: Value -> Parser Ref

parseJSONList :: Value -> Parser [Ref]

type Rep Ref

Defined in Dhall.Kubernetes.Types

type Rep Ref = D1 ('MetaData "Ref" "Dhall.Kubernetes.Types" "dhall-openapi-1.0.0-KLOyMybef0aKROwSDb8K2s" 'True) (C1 ('MetaCons "Ref" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRef") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype ModelName

Constructors

ModelName

Fields

• unModelName :: Text

Instances

Eq ModelName

Defined in Dhall.Kubernetes.Types

Methods

(==) :: ModelName -> ModelName -> Bool

(/=) :: ModelName -> ModelName -> Bool

Ord ModelName

Defined in Dhall.Kubernetes.Types

Methods

compare :: ModelName -> ModelName -> Ordering

(<) :: ModelName -> ModelName -> Bool

(<=) :: ModelName -> ModelName -> Bool

(>) :: ModelName -> ModelName -> Bool

(>=) :: ModelName -> ModelName -> Bool

max :: ModelName -> ModelName -> ModelName

min :: ModelName -> ModelName -> ModelName

Show ModelName

Defined in Dhall.Kubernetes.Types

Methods

showsPrec :: Int -> ModelName -> ShowS

show :: ModelName -> String

showList :: [ModelName] -> ShowS

Generic ModelName

Defined in Dhall.Kubernetes.Types

Associated Types

type Rep ModelName :: Type -> Type

Methods

from :: ModelName -> Rep ModelName x

to :: Rep ModelName x -> ModelName

FromJSONKey ModelName

Defined in Dhall.Kubernetes.Types

Methods

fromJSONKey :: FromJSONKeyFunction ModelName

fromJSONKeyList :: FromJSONKeyFunction [ModelName]

Pretty ModelName

Defined in Dhall.Kubernetes.Types

Methods

pretty :: ModelName -> Doc ann

prettyList :: [ModelName] -> Doc ann

type Rep ModelName

Defined in Dhall.Kubernetes.Types

type Rep ModelName = D1 ('MetaData "ModelName" "Dhall.Kubernetes.Types" "dhall-openapi-1.0.0-KLOyMybef0aKROwSDb8K2s" 'True) (C1 ('MetaCons "ModelName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unModelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype FieldName

Constructors

FieldName

Fields

• unFieldName :: Text

Instances

Eq FieldName

Defined in Dhall.Kubernetes.Types

Methods

(==) :: FieldName -> FieldName -> Bool

(/=) :: FieldName -> FieldName -> Bool

Ord FieldName

Defined in Dhall.Kubernetes.Types

Methods

compare :: FieldName -> FieldName -> Ordering

(<) :: FieldName -> FieldName -> Bool

(<=) :: FieldName -> FieldName -> Bool

(>) :: FieldName -> FieldName -> Bool

(>=) :: FieldName -> FieldName -> Bool

max :: FieldName -> FieldName -> FieldName

min :: FieldName -> FieldName -> FieldName

Show FieldName

Defined in Dhall.Kubernetes.Types

Methods

showsPrec :: Int -> FieldName -> ShowS

show :: FieldName -> String

showList :: [FieldName] -> ShowS

Generic FieldName

Defined in Dhall.Kubernetes.Types

Associated Types

type Rep FieldName :: Type -> Type

Methods

from :: FieldName -> Rep FieldName x

to :: Rep FieldName x -> FieldName

FromJSON FieldName

Defined in Dhall.Kubernetes.Types

Methods

parseJSON :: Value -> Parser FieldName

parseJSONList :: Value -> Parser [FieldName]

FromJSONKey FieldName

Defined in Dhall.Kubernetes.Types

Methods

fromJSONKey :: FromJSONKeyFunction FieldName

fromJSONKeyList :: FromJSONKeyFunction [FieldName]

Pretty FieldName

Defined in Dhall.Kubernetes.Types

Methods

pretty :: FieldName -> Doc ann

prettyList :: [FieldName] -> Doc ann

type Rep FieldName

Defined in Dhall.Kubernetes.Types

type Rep FieldName = D1 ('MetaData "FieldName" "Dhall.Kubernetes.Types" "dhall-openapi-1.0.0-KLOyMybef0aKROwSDb8K2s" 'True) (C1 ('MetaCons "FieldName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unFieldName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data BaseData

This contains the static data that a Model might have

This applies only to kubernetes resources where `$sel:kind:BaseData` and `$sel:apiVersion:BaseData` are statically determined by the resource. See the `Kubernetes OpenAPI Spec Readme`: https:/github.comkuberneteskubernetesblobmasterapiopenapi-specREADME.md#x-kubernetes-group-version-kind

For example for a v1 Deployment we have

{ kind = Deployment , apiVersion = "apps/v1" }

Constructors

BaseData

Fields

• kind :: Text
• apiVersion :: Text

Instances

Eq BaseData

Defined in Dhall.Kubernetes.Types

Methods

(==) :: BaseData -> BaseData -> Bool

(/=) :: BaseData -> BaseData -> Bool

Show BaseData

Defined in Dhall.Kubernetes.Types

Methods

showsPrec :: Int -> BaseData -> ShowS

show :: BaseData -> String

showList :: [BaseData] -> ShowS

Generic BaseData

Defined in Dhall.Kubernetes.Types

Associated Types

type Rep BaseData :: Type -> Type

Methods

from :: BaseData -> Rep BaseData x

to :: Rep BaseData x -> BaseData

FromJSON BaseData

Defined in Dhall.Kubernetes.Types

Methods

parseJSON :: Value -> Parser BaseData

parseJSONList :: Value -> Parser [BaseData]

type Rep BaseData

Defined in Dhall.Kubernetes.Types

type Rep BaseData = D1 ('MetaData "BaseData" "Dhall.Kubernetes.Types" "dhall-openapi-1.0.0-KLOyMybef0aKROwSDb8K2s" 'False) (C1 ('MetaCons "BaseData" 'PrefixI 'True) (S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "apiVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))