Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Server.Local.Endpoints.DefinitionSummary

Documentation

type TermSummaryAPI = "definitions" :> ("terms" :> ("by-hash" :> (Capture "hash" Referent :> ("summary" :> (QueryParam "name" Name :> (QueryParam "relativeTo" Path :> (QueryParam "renderWidth" Width :> APIGet TermSummary))))))) Source #

serveTermSummary :: Codebase IO Symbol Ann -> Referent -> Maybe Name -> Either ShortCausalHash CausalHash -> Maybe Path -> Maybe Width -> Backend IO TermSummary Source #

data TermSummary Source #

Constructors

TermSummary
Fields displayName :: HashQualified Name hash :: ShortHash summary :: DisplayObject SyntaxText SyntaxText tag :: TermTag

Instances

Instances details

ToJSON TermSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods toJSON :: TermSummary -> Value # toEncoding :: TermSummary -> Encoding # toJSONList :: [TermSummary] -> Value # toEncodingList :: [TermSummary] -> Encoding #
Generic TermSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Associated Types type Rep TermSummary :: Type -> Type # Methods from :: TermSummary -> Rep TermSummary x # to :: Rep TermSummary x -> TermSummary #
Show TermSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods showsPrec :: Int -> TermSummary -> ShowS # show :: TermSummary -> String # showList :: [TermSummary] -> ShowS #
ToSchema TermSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods declareNamedSchema :: Proxy TermSummary -> Declare (Definitions Schema) NamedSchema #
ToSample TermSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods toSamples :: Proxy TermSummary -> [(Text, TermSummary)] #
type Rep TermSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary type Rep TermSummary = D1 ('MetaData "TermSummary" "Unison.Server.Local.Endpoints.DefinitionSummary" "unison-share-api-0.0.0-C8EhduMcnIVLJzlEB6yMhH" 'False) (C1 ('MetaCons "TermSummary" 'PrefixI 'True) ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashQualified Name)) :: S1 ('MetaSel ('Just "hash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortHash)) :: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (DisplayObject SyntaxText SyntaxText)) :*: S1 ('MetaSel ('Just "tag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TermTag))))

type TypeSummaryAPI = "definitions" :> ("types" :> ("by-hash" :> (Capture "hash" Reference :> ("summary" :> (QueryParam "name" Name :> (QueryParam "relativeTo" Path :> (QueryParam "renderWidth" Width :> APIGet TypeSummary))))))) Source #

serveTypeSummary :: Codebase IO Symbol Ann -> Reference -> Maybe Name -> Either ShortCausalHash CausalHash -> Maybe Path -> Maybe Width -> Backend IO TypeSummary Source #

data TypeSummary Source #

Constructors

TypeSummary
Fields displayName :: HashQualified Name hash :: ShortHash summary :: DisplayObject SyntaxText SyntaxText tag :: TypeTag

Instances

Instances details

ToJSON TypeSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods toJSON :: TypeSummary -> Value # toEncoding :: TypeSummary -> Encoding # toJSONList :: [TypeSummary] -> Value # toEncodingList :: [TypeSummary] -> Encoding #
Generic TypeSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Associated Types type Rep TypeSummary :: Type -> Type # Methods from :: TypeSummary -> Rep TypeSummary x # to :: Rep TypeSummary x -> TypeSummary #
Show TypeSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods showsPrec :: Int -> TypeSummary -> ShowS # show :: TypeSummary -> String # showList :: [TypeSummary] -> ShowS #
ToSchema TypeSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods declareNamedSchema :: Proxy TypeSummary -> Declare (Definitions Schema) NamedSchema #
ToSample TypeSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary Methods toSamples :: Proxy TypeSummary -> [(Text, TypeSummary)] #
type Rep TypeSummary Source #
Instance details Defined in Unison.Server.Local.Endpoints.DefinitionSummary type Rep TypeSummary = D1 ('MetaData "TypeSummary" "Unison.Server.Local.Endpoints.DefinitionSummary" "unison-share-api-0.0.0-C8EhduMcnIVLJzlEB6yMhH" 'False) (C1 ('MetaCons "TypeSummary" 'PrefixI 'True) ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashQualified Name)) :: S1 ('MetaSel ('Just "hash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortHash)) :: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (DisplayObject SyntaxText SyntaxText)) :*: S1 ('MetaSel ('Just "tag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TypeTag))))