| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Unison.Server.Local.Endpoints.Definitions
Contents
Documentation
type DefinitionsAPI = ("getDefinition" :> GetDefinitionEndpoint) :<|> (("getDefinitionDependents" :> GetDefinitionDependentsEndpoint) :<|> ("getDefinitionDependencies" :> GetDefinitionDependenciesEndpoint)) Source #
type GetDefinitionEndpoint = QueryParam "relativeTo" Path :> (QueryParams "names" (HashQualified Name) :> (QueryParam "renderWidth" Width :> (QueryParam "suffixifyBindings" Suffixify :> APIGet DefinitionDisplayResults))) Source #
type GetDefinitionDependentsEndpoint = RequiredQueryParam "name" (HashQualified Name) :> (QueryParam "renderWidth" Width :> APIGet DefinitionSearchResults) Source #
type GetDefinitionDependenciesEndpoint = RequiredQueryParam "name" (HashQualified Name) :> (QueryParam "renderWidth" Width :> APIGet DefinitionSearchResults) Source #
getDefinitionDependentsEndpoint :: Runtime Symbol -> Codebase IO Symbol Ann -> ProjectAndBranch ProjectName ProjectBranchName -> HashQualified Name -> Maybe Width -> Backend IO (APIHeaders DefinitionSearchResults) Source #
getDefinitionDependenciesEndpoint :: Runtime Symbol -> Codebase IO Symbol Ann -> ProjectAndBranch ProjectName ProjectBranchName -> HashQualified Name -> Maybe Width -> Backend IO (APIHeaders DefinitionSearchResults) Source #
getDefinitionsEndpoint :: Runtime Symbol -> Codebase IO Symbol Ann -> ProjectAndBranch ProjectName ProjectBranchName -> Maybe Path -> [HashQualified Name] -> Maybe Width -> Maybe Suffixify -> Backend IO (APIHeaders DefinitionDisplayResults) Source #
serveDefinitionsServer :: Runtime Symbol -> Codebase IO Symbol Ann -> ProjectAndBranch ProjectName ProjectBranchName -> ServerT DefinitionsAPI (Backend IO) Source #
Orphan instances
| ToSample DefinitionDisplayResults Source # | |
Methods toSamples :: Proxy DefinitionDisplayResults -> [(Text, DefinitionDisplayResults)] # | |
| ToParam (QueryParam "namespace" Path) Source # | |
Methods toParam :: Proxy (QueryParam "namespace" Path) -> DocQueryParam # | |
| ToParam (QueryParam "relativeTo" Path) Source # | |
Methods toParam :: Proxy (QueryParam "relativeTo" Path) -> DocQueryParam # | |
| ToParam (QueryParam "renderWidth" Width) Source # | |
Methods toParam :: Proxy (QueryParam "renderWidth" Width) -> DocQueryParam # | |
| ToParam (QueryParam "suffixifyBindings" Suffixify) Source # | |
Methods toParam :: Proxy (QueryParam "suffixifyBindings" Suffixify) -> DocQueryParam # | |
| ToParam (QueryParams "names" (HashQualified Name)) Source # | |
Methods toParam :: Proxy (QueryParams "names" (HashQualified Name)) -> DocQueryParam # | |