Documentation
¶
Index ¶
- Constants
- Variables
- func ShowJSON(res gjson.Result, opts ShowJSONOpts) error
- func ShowJSONIterator[T any](iter jsonview.Iterator[T], itemsToDisplay int64, opts ShowJSONOpts) error
- func ValidateBaseURL(value, source string) error
- type BodyContentType
- type FileEmbedStyle
- type FilePathValue
- type ShowJSONOpts
Constants ¶
View Source
const Version = "0.29.0" // x-release-please-version
Variables ¶
View Source
var ( Command *cli.Command CommandErrorBuffer bytes.Buffer )
View Source
var OutputFormats = []string{"auto", "explore", "json", "jsonl", "pretty", "raw", "yaml"}
Functions ¶
func ShowJSON ¶
func ShowJSON(res gjson.Result, opts ShowJSONOpts) error
ShowJSON displays a single JSON result to the user.
func ShowJSONIterator ¶
func ShowJSONIterator[T any](iter jsonview.Iterator[T], itemsToDisplay int64, opts ShowJSONOpts) error
ShowJSONIterator displays an iterator of values to the user. Use itemsToDisplay = -1 for no limit.
func ValidateBaseURL ¶
ValidateBaseURL checks that a base URL is correctly prefixed with a protocol scheme and produces a better error message than the person would see otherwise if it doesn't.
Types ¶
type BodyContentType ¶
type BodyContentType int
const ( EmptyBody BodyContentType = iota MultipartFormEncoded ApplicationJSON ApplicationOctetStream )
type FileEmbedStyle ¶
type FileEmbedStyle int
const ( // EmbedText reads referenced files fully into memory and substitutes the file's contents back into the // value as a string. Binary files are base64-encoded. Used for JSON request bodies and for headers and // query parameters, where the file contents need to be serialized inline. EmbedText FileEmbedStyle = iota // EmbedIOReader replaces file references with an io.Reader that streams the file's contents. Used for // `multipart/form-data` and `application/octet-stream` request bodies, where files are uploaded as binary // parts rather than embedded into a text value. EmbedIOReader )
type FilePathValue ¶
type FilePathValue string
FilePathValue is a string wrapper that marks a value as a file path whose contents should be read and embedded in the request. Unlike a regular string, embedFilesValue always treats a FilePathValue as a file path without needing the "@" prefix.
type ShowJSONOpts ¶ added in v0.22.0
type ShowJSONOpts struct {
ExplicitFormat bool // true if the user explicitly passed --format
Format string // output format (auto, explore, json, jsonl, pretty, raw, yaml)
RawOutput bool // like jq -r: print strings without JSON quotes
Stderr io.Writer // stderr for warnings; injectable for testing; defaults to os.Stderr
Stdout *os.File // stdout (or pager); injectable for testing; defaults to os.Stdout
Title string // display title
Transform string // GJSON path to extract before displaying
}
ShowJSONOpts configures how JSON output is displayed.
Source Files
¶
- account.go
- accountnumber.go
- accountstatement.go
- accounttransfer.go
- achprenotification.go
- achtransfer.go
- beneficialowner.go
- bookkeepingaccount.go
- bookkeepingentry.go
- bookkeepingentryset.go
- card.go
- carddispute.go
- cardpayment.go
- cardpurchasesupplement.go
- cardpushtransfer.go
- cardtoken.go
- cardvalidation.go
- checkdeposit.go
- checktransfer.go
- cmd.go
- cmdutil.go
- cmdutil_unix.go
- declinedtransaction.go
- digitalcardprofile.go
- digitalwallettoken.go
- entity.go
- entityonboardingsession.go
- event.go
- eventsubscription.go
- export.go
- externalaccount.go
- fednowtransfer.go
- file.go
- filelink.go
- flagoptions.go
- group.go
- inboundachtransfer.go
- inboundcheckdeposit.go
- inboundfednowtransfer.go
- inboundmailitem.go
- inboundrealtimepaymentstransfer.go
- inboundwiredrawdownrequest.go
- inboundwiretransfer.go
- intrafiaccountenrollment.go
- intrafibalance.go
- intrafiexclusion.go
- lockbox.go
- oauthapplication.go
- oauthconnection.go
- oauthtoken.go
- pendingtransaction.go
- physicalcard.go
- physicalcardprofile.go
- program.go
- realtimedecision.go
- realtimepaymentstransfer.go
- routingnumber.go
- simulationaccountstatement.go
- simulationachtransfer.go
- simulationcardauthentication.go
- simulationcardauthorization.go
- simulationcardauthorizationexpiration.go
- simulationcardbalanceinquiry.go
- simulationcarddispute.go
- simulationcardfuelconfirmation.go
- simulationcardincrement.go
- simulationcardpurchasesupplement.go
- simulationcardrefund.go
- simulationcardreversal.go
- simulationcardsettlement.go
- simulationcardtoken.go
- simulationcheckdeposit.go
- simulationchecktransfer.go
- simulationdigitalwallettokenrequest.go
- simulationentityonboardingsession.go
- simulationexport.go
- simulationinboundachtransfer.go
- simulationinboundcheckdeposit.go
- simulationinboundfednowtransfer.go
- simulationinboundmailitem.go
- simulationinboundrealtimepaymentstransfer.go
- simulationinboundwiredrawdownrequest.go
- simulationinboundwiretransfer.go
- simulationinterestpayment.go
- simulationpendingtransaction.go
- simulationphysicalcard.go
- simulationprogram.go
- simulationrealtimepaymentstransfer.go
- simulationwiredrawdownrequest.go
- simulationwiretransfer.go
- suggest.go
- supplementaldocument.go
- swifttransfer.go
- transaction.go
- version.go
- wiredrawdownrequest.go
- wiretransfer.go
Click to show internal directories.
Click to hide internal directories.