STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3400 from embano1/patch-1

Browse source 
Add note on supported value types in raw-fields
This commit is contained in:
Mislav Marohnić 2021-04-20 18:49:41 +02:00 • committed by GitHub
commit a3a7deadb8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
pkg/cmd/api/api.go
View file

@ -77,8 +77,10 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
The default HTTP request method is "GET" normally and "POST" if any parameters
were added. Override the method with %[1]s--method%[1]s.
Pass one or more %[1]s--raw-field%[1]s values in "key=value" format to add
JSON-encoded string parameters to the POST body.
Pass one or more %[1]s--raw-field%[1]s values in "key=value" format to add string
parameters to the request payload. To add non-string parameters, see %[1]s--field%[1]s below.
Note that adding request parameters will automatically switch the request method to POST.
To send the parameters as a GET query string instead, use %[1]s--method%[1]s GET.
The %[1]s--field%[1]s flag behaves like %[1]s--raw-field%[1]s with magic type conversion based
on the format of the value: