Parse a servant client; the result can be run. The choice of m gives the backend you are using; for example, the default GHC servant-client backend is ClientM.

Returns the request response, which is usually a layer of Either for every endpoint branch. You can find the response type directly by using typed holes or asking ghci with :t or :kind! forall m. CLIResult m MyAPI. Because it might be tedious handling nested Eithers, see parseHandleClient for a way to handle each potential branch in a convenient way.

Takes options on how the top-level prompt is displayed when given "--help"; it can be useful for adding a header or program description. Otherwise, just use mempty.

Parse a server client, like parseClient. However, instead of that client action returning the request response, instead use a CLIHandler to handle every potential request response. It essentially lets you specify how to sort each potential endpoint's response into a single output value.

The handler is usually a :<|> for every endpoint branch. You can find it by using typed holes or asking ghci with :t or :kind! forall m r. CLIHandler m MyAPI r.

Takes options on how the top-level prompt is displayed when given "--help"; it can be useful for adding a header or program description. Otherwise, just use mempty.

A version of parseClient that can be used if the API requires any external context to generate runtime data.

A version of parseHandleClient that can be used if the API requires any external context to generate runtime data.

Typeclass defining how each API combinator influences how a server can be interacted with using command line options.

Note that query parameters and captures all require servant-docs annotation instances, to allow for proper help messages.

Unless you are adding new combinators to be used with APIs, you can ignore this class.

Data family associating API combinators with contexts required to run them. These typically will be actions in m that fetch/generate the required data, and will only be "run" if the user selects an endpoint that requires it through the command line interface.

Contains a subcontext that can be descended down into using NamedContext. Mirrors NamedContext.

Useful for when you have multiple items with the same name within a context; this essentially creates a namespace for context items.

Allows you to access NamedContexts inside a context.

Create a structure for a command line parser.

This can be useful if you are combining functionality with existing optparse-applicative parsers. You can convert a PStruct to a Parser using structParser.

A version of cliPStruct that can be used if the API requires any external context to generate runtime data.

Convert a PStruct into a command line argument parser, from the optparse-applicative library. It can be run with execParser.

It takes options on how the top-level prompt is displayed when given "--help"; it can be useful for adding a header or program description. Otherwise, just use mempty.

Create a structure for a command line parser, producing results according to a CLIHandler. See parseHandleClient for more information.

This can be useful if you are combining functionality with existing optparse-applicative parsers. You can convert a PStruct to a Parser using structParser.

A version of cliHandlePStruct that can be used if the API requires any external context to generate runtime data.

A helper class for defining directly how to parse request bodies. This allows more complex parsing of bodies.

You need an instance of this for every type you use with ReqBody.

Default implementation that expects a --data option.

The class that helps us automatically get documentation for URL captures.

Example of an instance:

instance ToCapture (Capture "name" Text) where
  toCapture _ = DocCapture "name" "name of the person to greet"

A type to represent captures. Holds the name of the capture and a description.

Write a ToCapture instance for your captured types.

The class that helps us automatically get documentation for GET (or other Method) parameters.

Example of an instance:

instance ToParam (QueryParam' mods "capital" Bool) where
  toParam _ =
    DocQueryParam "capital"
                  ["true", "false"]
                  "Get the greeting message in uppercase (true) or not (false). Default is false."

A type to represent a GET (or other possible Method) parameter from the Query String. Holds its name, the possible values (leave empty if there isn't a finite number of them), and a description of how it influences the output or behavior.

Write a ToParam instance for your GET parameter types

Type of GET (or other Method) parameter:

• Normal corresponds to QueryParam, i.e your usual GET parameter
• List corresponds to QueryParams, i.e GET parameters with multiple values
• Flag corresponds to QueryFlag, i.e a value-less GET parameter

The class that helps us get documentation for authenticated endpoints

A type to represent Authentication information about an endpoint.