Improve GitHub CLI request example for updating custom values

[NovemberTang]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/repos/custom-properties?apiVersion=2022-11-28#create-or-update-custom-property-values-for-a-repository

What part(s) of the article would you like to see updated?

In the request example section the GitHub CLI example looks like this

gh api \
  --method PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /repos/OWNER/REPO/properties/values \
  -F "properties[]=[object Object]" -F "properties[]=[object Object]" -F "properties[]=[object Object]" 

-F "properties[]=[object Object]" is repeated three times, which looks like it might be an error, if properties[] is meant to be a list. It would also be really helpful to have a concrete example of how to format the string I pass in place of [object Object] as I've not been able to figure it out by myself.

Additional information

No response

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[pablonete]

We've been investigating it this morning, so adding some info here to help improving this documentation:

It works with this syntax:

gh api \
  --method PATCH \
  /repos/properties-game/chess/properties/values \
  -F 'properties[][property_name]'='color' \
  -F 'properties[][value]'='red'

but only for one property (color in the example)

In order to update more than 1 property on the same request, users can use the --input param. It supports a body file, or it can be piped with standard input -:

echo '{"properties": [{"property_name": "color", "value": "red"}] }' | gh api --method PATCH /repos/properties-game/chess/properties/values --input -

Most of this is common guidance for the gh api command dealing with JSON request bodies.

UPDATE: there's a goal of making the original syntax work in CLI, tracked here: cli/cli#8621

[NovemberTang]

We've been investigating it this morning, so adding some info here to help improving this documentation:

Thanks @pablonete , this is really useful!

[nguyenalex836]

@NovemberTang Thank you for opening this issue! I'll get this triaged for review ✨

[nguyenalex836]

Internal: followed up here

[docs-bot]

Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.