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.13.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 ¶ added in v0.12.0
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 ¶ added in v0.12.0
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.13.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
¶
- accessipaddress.go
- accessiprange.go
- actionpurchase.go
- actionregister.go
- address.go
- addressaction.go
- advancedorder.go
- ai.go
- aiassistant.go
- aiassistantcanarydeploy.go
- aiassistantscheduledevent.go
- aiassistanttag.go
- aiassistanttest.go
- aiassistanttestrun.go
- aiassistanttesttestsuite.go
- aiassistanttesttestsuiterun.go
- aiassistanttool.go
- aiassistantversion.go
- aiaudio.go
- aichat.go
- aicluster.go
- aiconversation.go
- aiconversationinsight.go
- aiconversationinsightgroup.go
- aiconversationinsightgroupinsight.go
- aiconversationmessage.go
- aiembedding.go
- aiembeddingbucket.go
- aifinetuningjob.go
- aiintegration.go
- aiintegrationconnection.go
- aimcpserver.go
- aimission.go
- aimissionknowledgebase.go
- aimissionmcpserver.go
- aimissionrun.go
- aimissionrunevent.go
- aimissionrunplan.go
- aimissionruntelnyxagent.go
- aimissiontool.go
- aiopenaiembedding.go
- aitool.go
- alphanumericsenderid.go
- auditevent.go
- authenticationprovider.go
- availablephonenumber.go
- availablephonenumberblock.go
- balance.go
- billinggroup.go
- bulksimcardaction.go
- bundlepricingbillingbundle.go
- bundlepricinguserbundle.go
- call.go
- callaction.go
- callcontrolapplication.go
- callevent.go
- channelzone.go
- chargesbreakdown.go
- chargessummary.go
- cmd.go
- cmdutil.go
- cmdutil_unix.go
- comment.go
- conference.go
- conferenceaction.go
- connection.go
- countrycoverage.go
- credentialconnection.go
- credentialconnectionaction.go
- customerservicerecord.go
- customstoragecredential.go
- detailrecord.go
- dialogflowconnection.go
- document.go
- documentlink.go
- dynamicemergencyaddress.go
- dynamicemergencyendpoint.go
- enterprise.go
- enterprisereputation.go
- enterprisereputationnumber.go
- externalconnection.go
- externalconnectioncivicaddress.go
- externalconnectionlogmessage.go
- externalconnectionphonenumber.go
- externalconnectionrelease.go
- externalconnectionupload.go
- fax.go
- faxaction.go
- faxapplication.go
- flagoptions.go
- fqdn.go
- fqdnconnection.go
- globalip.go
- globalipallowedport.go
- globalipassignment.go
- globalipassignmenthealth.go
- globalipassignmentsusage.go
- globaliphealthcheck.go
- globaliphealthchecktype.go
- globaliplatency.go
- globalipprotocol.go
- globalipusage.go
- inboundchannel.go
- inexplicitnumberorder.go
- integrationsecret.go
- inventorycoverage.go
- invoice.go
- ip.go
- ipconnection.go
- ledgerbillinggroupreport.go
- legacyreportingbatchdetailrecordmessaging.go
- legacyreportingbatchdetailrecordspeechtotext.go
- legacyreportingbatchdetailrecordvoice.go
- legacyreportingusagereport.go
- legacyreportingusagereportmessaging.go
- legacyreportingusagereportnumberlookup.go
- legacyreportingusagereportvoice.go
- list.go
- managedaccount.go
- managedaccountaction.go
- media.go
- message.go
- messagerc.go
- messaging10dlc.go
- messaging10dlcbrand.go
- messaging10dlcbrandexternalvetting.go
- messaging10dlccampaign.go
- messaging10dlccampaignbuilder.go
- messaging10dlccampaignbuilderbrand.go
- messaging10dlccampaignosr.go
- messaging10dlccampaignusecase.go
- messaging10dlcpartnercampaign.go
- messaging10dlcphonenumberassignmentbyprofile.go
- messaging10dlcphonenumbercampaign.go
- messaginghostednumber.go
- messaginghostednumberorder.go
- messaginghostednumberorderaction.go
- messagingnumbersbulkupdate.go
- messagingoptout.go
- messagingprofile.go
- messagingprofileaction.go
- messagingprofileautorespconfig.go
- messagingprofilemetric.go
- messagingrc.go
- messagingrcagent.go
- messagingtollfreeverificationrequest.go
- messagingurldomain.go
- mobilenetworkoperator.go
- mobilephonenumber.go
- mobilephonenumbermessaging.go
- mobilepushcredential.go
- mobilevoiceconnection.go
- network.go
- networkcoverage.go
- networkdefaultgateway.go
- notificationchannel.go
- notificationevent.go
- notificationeventcondition.go
- notificationprofile.go
- notificationsetting.go
- numberblockorder.go
- numberlookup.go
- numberorder.go
- numberorderphonenumber.go
- numberreservation.go
- numberreservationaction.go
- numbersfeature.go
- oauth.go
- oauthclient.go
- oauthgrant.go
- operatorconnectaction.go
- organizationuser.go
- organizationuseraction.go
- otaupdate.go
- outboundvoiceprofile.go
- payment.go
- paymentautorechargepref.go
- phonenumber.go
- phonenumberaction.go
- phonenumberblockjob.go
- phonenumbercsvdownload.go
- phonenumberjob.go
- phonenumbermessaging.go
- phonenumbersregulatoryrequirement.go
- phonenumbervoice.go
- phonenumbervoicemail.go
- portabilitycheck.go
- porting.go
- portingevent.go
- portingloaconfiguration.go
- portingorder.go
- portingorderaction.go
- portingorderactionrequirement.go
- portingorderactivationjob.go
- portingorderadditionaldocument.go
- portingorderassociatedphonenumber.go
- portingordercomment.go
- portingorderphonenumberblock.go
- portingorderphonenumberconfiguration.go
- portingorderphonenumberextension.go
- portingorderverificationcode.go
- portingphonenumber.go
- portingreport.go
- portout.go
- portoutcomment.go
- portoutevent.go
- portoutreport.go
- portoutsupportingdocument.go
- privatewirelessgateway.go
- pronunciationdict.go
- publicinternetgateway.go
- queue.go
- queuecall.go
- recording.go
- recordingaction.go
- recordingtranscription.go
- region.go
- regulatoryrequirement.go
- report.go
- reportcdrusagereport.go
- reportmdrusagereport.go
- reputationnumber.go
- requirement.go
- requirementgroup.go
- requirementtype.go
- room.go
- roomaction.go
- roomcomposition.go
- roomparticipant.go
- roomrecording.go
- roomsession.go
- roomsessionaction.go
- sessionanalysis.go
- sessionanalysismetadata.go
- seti.go
- shortcode.go
- simcard.go
- simcardaction.go
- simcarddatausagenotification.go
- simcardgroup.go
- simcardgroupaction.go
- simcardorder.go
- simcardorderpreview.go
- siprecconnector.go
- storage.go
- storagebucket.go
- storagebucketsslcertificate.go
- storagebucketusage.go
- storagemigration.go
- storagemigrationaction.go
- storagemigrationsource.go
- subnumberorder.go
- subnumberordersreport.go
- suggest.go
- telephonycredential.go
- termsofservicenumberreputation.go
- texml.go
- texmlaccount.go
- texmlaccountcall.go
- texmlaccountcallrecording.go
- texmlaccountcallrecordingsjson.go
- texmlaccountcallsiprec.go
- texmlaccountcallstream.go
- texmlaccountconference.go
- texmlaccountconferenceparticipant.go
- texmlaccountqueue.go
- texmlaccountrecordingjson.go
- texmlaccounttranscriptionjson.go
- texmlapplication.go
- texttospeech.go
- trafficpolicyprofile.go
- usagereport.go
- useraddress.go
- usertag.go
- verification.go
- verificationaction.go
- verificationbyphonenumber.go
- verificationbyphonenumberaction.go
- verifiednumber.go
- verifiednumberaction.go
- verifyprofile.go
- version.go
- virtualcrossconnect.go
- virtualcrossconnectscoverage.go
- voiceclone.go
- voicedesign.go
- webhookdelivery.go
- wellknown.go
- whatsappbusinessaccount.go
- whatsappbusinessaccountphonenumber.go
- whatsappbusinessaccountsetting.go
- whatsappmessagetemplate.go
- whatsappphonenumber.go
- whatsappphonenumbercallingsetting.go
- whatsappphonenumberprofile.go
- whatsappphonenumberprofilephoto.go
- whatsapptemplate.go
- wireguardinterface.go
- wireguardpeer.go
- wireless.go
- wirelessblocklist.go
- wirelessblocklistvalue.go
- wirelessdetailrecordsreport.go
- x402creditaccount.go
Click to show internal directories.
Click to hide internal directories.