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(Map<String,Object> attributes)
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(Map<String,Object> attributes)
Returns a new
Snippet that will document the HTTPie request for the API
operation. |
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 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 attributes