Skip to content

Supported passing nested JSON arrays/objects to api command via fields #6614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mislav merged 5 commits into from
Dec 22, 2022
Merged

Supported passing nested JSON arrays/objects to api command via fields #6614

mislav merged 5 commits into from
Dec 22, 2022

Conversation

@mislav
Copy link
Contributor

@mislav mislav commented Nov 14, 2022

Examples:

gh api -f labels[]=bug -f labels[]=p1
#=> { "labels": ["bug", "p1"] }

gh api -f branch[name]=patch-1 -F branch[protected]=true
#=> { "branch": { "name": "patch-1", "protected": true }

Fixes #1484

@mislav
api: supported passing nested JSON arrays/objects via fields
718d151 
Examples:

	-f labels[]=bug -f labels[]=p1
        #=> { "labels": ["bug", "p1"] }

	-f branch[name]=patch-1 -F branch[protected]=true
        #=> { "branch": { "name": "patch-1", "protected": true }
@mislav mislav requested a review from a team as a code owner November 14, 2022 17:30
@mislav mislav requested review from vilmibm and removed request for a team November 14, 2022 17:30
samcoe
samcoe reviewed Dec 5, 2022
View reviewed changes
Copy link
Contributor

@samcoe samcoe left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. I would like to see this new feature syntax documented in the api command help section or perhaps in a new top level help topic.

Two discussion questions:

  1. Was there thoughts on adding deep nesting support, e.g -f branch[foo[bar]]=patch-1?
  2. What do you think about changing the array syntax to be []key rather than key[]? Perhaps I have been looking at too much Go code, but the brackets in front seem more natural to me.

@mislav
Copy link
Contributor Author

mislav commented Dec 22, 2022 •
edited
Loading

@samcoe Thanks for the review!

  1. Was there thoughts on adding deep nesting support, e.g -f branch[foo[bar]]=patch-1?

Great idea! Just added with the syntax branch[foo][bar]=patch1.

  1. What do you think about changing the array syntax to be []key rather than key[]? Perhaps I have been looking at too much Go code, but the brackets in front seem more natural to me.

The newest code supports interspersed nested object/array syntax, e.g.:

-f labels[][name]=bug
-f labels[][color]=red
-f labels[][name]=feature
-f labels[][color]=green

This results in a labels array populated with objects that each have fields {name,color}. To support this case, I think that key[] syntax is more consistent than []key because it's similar to the syntax for nested objects (except that empty brackets signify that there is no key name).

@mislav mislav merged commit c5c2f9c into trunk Dec 22, 2022
@mislav mislav deleted the json-fields-api branch December 22, 2022 19:12
@dentarg dentarg mentioned this pull request Dec 22, 2022
Open
0x2b3bfa0 added a commit to 0x2b3bfa0/age that referenced this pull request Jan 6, 2023
@0x2b3bfa0
.github/workflows: trigger interop. tests using gh
ef3637f 
* cli/cli#6614
@0x2b3bfa0 0x2b3bfa0 mentioned this pull request Jan 6, 2023
Merged
FiloSottile pushed a commit to 0x2b3bfa0/age that referenced this pull request Apr 22, 2023
@0x2b3bfa0 @FiloSottile
.github/workflows: trigger interop. tests using gh
c58eecc 
* cli/cli#6614
@mislav mislav mentioned this pull request May 30, 2023
Merged
@Ebonsignori Ebonsignori mentioned this pull request Feb 27, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vilmibm vilmibm Awaiting requested review from vilmibm vilmibm is a code owner automatically assigned from cli/code-reviewers

1 more reviewer

@samcoe samcoe samcoe left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@mislav mislav

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Allow JSON array parameters in gh api

3 participants

@mislav @samcoe