Proto3.Suite.DotProto.Generate.Swagger

This module provides helper functions to generate Swagger schemas that describe JSONPB encodings for protobuf types.

Documentation

ppSchema :: ToSchema a => Proxy a -> IO ()

Pretty-prints a schema. Useful when playing around with schemas in the REPL.

newtype OverrideToSchema a

This is a hack to work around the swagger2 library forbidding ToSchema instances for ByteStrings

Constructors

OverrideToSchema

Fields

• unOverride :: a

Instances

ToSchema (OverrideToSchema (Maybe ByteString))

This instance is the same as the instance for OverrideToSchema ByteString. See: https://hackage.haskell.org/package/swagger2-2.6/docs/src/Data.Swagger.Internal.Schema.html#line-451

Defined in Proto3.Suite.DotProto.Generate.Swagger

Methods

declareNamedSchema :: Proxy (OverrideToSchema (Maybe ByteString)) -> Declare (Definitions Schema) NamedSchema

ToSchema a => ToSchema (OverrideToSchema a)

Defined in Proto3.Suite.DotProto.Generate.Swagger

Methods

declareNamedSchema :: Proxy (OverrideToSchema a) -> Declare (Definitions Schema) NamedSchema

ToSchema (OverrideToSchema ByteString)

Defined in Proto3.Suite.DotProto.Generate.Swagger

Methods

declareNamedSchema :: Proxy (OverrideToSchema ByteString) -> Declare (Definitions Schema) NamedSchema

(ToJSONKey k, ToSchema k) => ToSchema (OverrideToSchema (Map k ByteString))

Defined in Proto3.Suite.DotProto.Generate.Swagger

Methods

declareNamedSchema :: Proxy (OverrideToSchema (Map k ByteString)) -> Declare (Definitions Schema) NamedSchema

ToSchema (OverrideToSchema (Vector ByteString))

Defined in Proto3.Suite.DotProto.Generate.Swagger

Methods

declareNamedSchema :: Proxy (OverrideToSchema (Vector ByteString)) -> Declare (Definitions Schema) NamedSchema

asProxy :: (Proxy (OverrideToSchema a) -> b) -> Proxy a

This is a convenience function that uses type inference to select the correct instance of ToSchema to use for fields of a message

insOrdFromList :: (Eq k, Hashable k) => [(k, v)] -> InsOrdHashMap k v

Convenience re-export so that users of generated code don't have to add an explicit dependency on insert-ordered-containers

Orphan instances

(Finite e, Named e) => ToSchema (Enumerated e)

JSONPB schemas for protobuf enumerations

Methods

declareNamedSchema :: Proxy (Enumerated e) -> Declare (Definitions Schema) NamedSchema

ToSchema (Fixed Int32)

Methods

declareNamedSchema :: Proxy (Fixed Int32) -> Declare (Definitions Schema) NamedSchema

ToSchema (Fixed Int64)

Methods

declareNamedSchema :: Proxy (Fixed Int64) -> Declare (Definitions Schema) NamedSchema

ToSchema (Fixed Word32)

Methods

declareNamedSchema :: Proxy (Fixed Word32) -> Declare (Definitions Schema) NamedSchema

ToSchema (Fixed Word64)

Methods

declareNamedSchema :: Proxy (Fixed Word64) -> Declare (Definitions Schema) NamedSchema