Safe Haskell	None
Language	Haskell2010

Proto3.Suite.DotProto.Generate.Swagger

Contents

Orphan instances

Description

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

Synopsis

ppSchema :: ToSchema a => Proxy a -> IO ()
asProxy :: (Proxy a -> b) -> Proxy a
insOrdFromList :: (Eq k, Hashable k) => [(k, v)] -> InsOrdHashMap k v

Documentation

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

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

asProxy :: (Proxy a -> b) -> Proxy a Source #

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 Source #

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

Orphan instances

ToSchema a => ToSchema (Wrapped a) Source #
Instance details Methods declareNamedSchema :: Proxy (Wrapped a) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema (Maybe a) => ToSchema (Nested a) Source #
Instance details Methods declareNamedSchema :: Proxy (Nested a) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema a => ToSchema (NestedVec a) Source #
Instance details Methods declareNamedSchema :: Proxy (NestedVec a) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema a => ToSchema (UnpackedVec a) Source #
Instance details Methods declareNamedSchema :: Proxy (UnpackedVec a) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema a => ToSchema (PackedVec a) Source #
Instance details Methods declareNamedSchema :: Proxy (PackedVec a) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema (Bytes a) Source #
Instance details Methods declareNamedSchema :: Proxy (Bytes a) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema (String a) Source #
Instance details Methods declareNamedSchema :: Proxy (String a) -> Declare (Definitions Schema) NamedSchema Source #
(Finite e, Named e) => ToSchema (Enumerated e) Source #	JSONPB schemas for protobuf enumerations
Instance details Methods declareNamedSchema :: Proxy (Enumerated e) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema a => ToSchema (Signed a) Source #
Instance details Methods declareNamedSchema :: Proxy (Signed a) -> Declare (Definitions Schema) NamedSchema Source #
ToSchema a => ToSchema (Fixed a) Source #
Instance details Methods declareNamedSchema :: Proxy (Fixed a) -> Declare (Definitions Schema) NamedSchema Source #