OpenAPI.Generate.Reference

Contains function to resolve references within the OpenAPI specification

Documentation

type ReferenceMap = Map Text ComponentReference

A lookup table for references within the OpenAPI specification

data ComponentReference

Represents all types the ReferenceMap can hold

Constructors

SchemaReference SchemaObject

ResponseReference ResponseObject

ParameterReference ParameterObject

ExampleReference ExampleObject

RequestBodyReference RequestBodyObject

HeaderReference HeaderObject

SecuritySchemeReference SecuritySchemeObject

Instances

Eq ComponentReference

Defined in OpenAPI.Generate.Reference

Methods

(==) :: ComponentReference -> ComponentReference -> Bool

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

Show ComponentReference

Defined in OpenAPI.Generate.Reference

Methods

showsPrec :: Int -> ComponentReference -> ShowS

show :: ComponentReference -> String

showList :: [ComponentReference] -> ShowS

Generic ComponentReference

Defined in OpenAPI.Generate.Reference

Associated Types

type Rep ComponentReference :: Type -> Type

Methods

from :: ComponentReference -> Rep ComponentReference x

to :: Rep ComponentReference x -> ComponentReference

type Rep ComponentReference

Defined in OpenAPI.Generate.Reference

type Rep ComponentReference = D1 (MetaData "ComponentReference" "OpenAPI.Generate.Reference" "openapi3-code-generator-0.1.0.3-1OaHL9E6HNIKTuCXmNJefD" False) ((C1 (MetaCons "SchemaReference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SchemaObject)) :+: (C1 (MetaCons "ResponseReference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ResponseObject)) :+: C1 (MetaCons "ParameterReference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParameterObject)))) :+: ((C1 (MetaCons "ExampleReference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExampleObject)) :+: C1 (MetaCons "RequestBodyReference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RequestBodyObject))) :+: (C1 (MetaCons "HeaderReference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HeaderObject)) :+: C1 (MetaCons "SecuritySchemeReference" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SecuritySchemeObject)))))

buildReferenceMap :: OpenApiSpecification -> ReferenceMap

Creates a ReferenceMap from an OpenApiSpecification containing all elements within components. It does not capture possibly referenced locations anywhere else in the specification.

getSchemaReference :: Text -> ReferenceMap -> Maybe SchemaObject

Resolve a SchemaObject reference from a ReferenceMap

getResponseReference :: Text -> ReferenceMap -> Maybe ResponseObject

Resolve a ResponseObject reference from a ReferenceMap

getParameterReference :: Text -> ReferenceMap -> Maybe ParameterObject

Resolve a ParameterObject reference from a ReferenceMap

getExampleReference :: Text -> ReferenceMap -> Maybe ExampleObject

Resolve a ExampleObject reference from a ReferenceMap

getRequestBodyReference :: Text -> ReferenceMap -> Maybe RequestBodyObject

Resolve a RequestBodyObject reference from a ReferenceMap

getHeaderReference :: Text -> ReferenceMap -> Maybe HeaderObject

Resolve a HeaderObject reference from a ReferenceMap

getSecuritySchemeReference :: Text -> ReferenceMap -> Maybe SecuritySchemeObject

Resolve a SecuritySchemeObject reference from a ReferenceMap