public abstract class CliDocumentation extends Object
Modifier and Type | Method and Description |
---|---|
static Snippet |
curlRequest()
Returns a new
Snippet that will document the curl request for the API
operation. |
static Snippet |
curlRequest(CommandFormatter commandFormatter)
Returns a new
Snippet that will document the curl request for the API
operation. |
static Snippet |
curlRequest(Map<String,Object> attributes)
Returns a new
Snippet that will document the curl request for the API
operation. |
static Snippet |
curlRequest(Map<String,Object> attributes,
CommandFormatter commandFormatter)
Returns a new
Snippet that will document the curl request for the API
operation. |
static Snippet |
httpieRequest()
Returns a new
Snippet that will document the HTTPie request for the API
operation. |
static Snippet |
httpieRequest(CommandFormatter commandFormatter)
Returns a new
Snippet that will document the HTTPie request for the API
operation. |
static Snippet |
httpieRequest(Map<String,Object> attributes)
Returns a new
Snippet that will document the HTTPie request for the API
operation. |
static Snippet |
httpieRequest(Map<String,Object> attributes,
CommandFormatter commandFormatter)
Returns a new
Snippet that will document the HTTPie request for the API
operation. |
static CommandFormatter |
multiLineFormat()
Creates a new
CommandFormatter that produces multi-line output. |
static CommandFormatter |
singleLineFormat()
Creates a new
CommandFormatter that produces single-line output. |
public static Snippet curlRequest()
Snippet
that will document the curl request for the API
operation.public static Snippet curlRequest(Map<String,Object> attributes)
Snippet
that will document the curl request for the API
operation. The given attributes
will be available during snippet
generation.attributes
- the attributespublic static Snippet curlRequest(CommandFormatter commandFormatter)
Snippet
that will document the curl request for the API
operation. The given commandFormatter
will be used to format the curl
command in the snippet.commandFormatter
- the command formatterpublic static Snippet curlRequest(Map<String,Object> attributes, CommandFormatter commandFormatter)
Snippet
that will document the curl request for the API
operation. The given attributes
will be available during snippet
generation. The given commandFormatter
will be used to format the curl
command in the snippet.attributes
- the attributescommandFormatter
- the command formatterpublic static Snippet httpieRequest()
Snippet
that will document the HTTPie request for the API
operation.public static Snippet httpieRequest(Map<String,Object> attributes)
Snippet
that will document the HTTPie request for the API
operation. The given attributes
will be available during snippet
generation.attributes
- the attributespublic static Snippet httpieRequest(CommandFormatter commandFormatter)
Snippet
that will document the HTTPie request for the API
operation. The given commandFormatter
will be used to format the HTTPie
command in the snippet.commandFormatter
- the command formatterpublic static Snippet httpieRequest(Map<String,Object> attributes, CommandFormatter commandFormatter)
Snippet
that will document the HTTPie request for the API
operation. The given attributes
will be available during snippet
generation. The given commandFormatter
will be used to format the HTTPie
command in the snippet snippet.attributes
- the attributescommandFormatter
- the command formatterpublic static CommandFormatter multiLineFormat()
CommandFormatter
that produces multi-line output.CommandFormatter
public static CommandFormatter singleLineFormat()
CommandFormatter
that produces single-line output.CommandFormatter