Skip to content

Add note on supported value types in raw-fields#3400

Merged
mislav merged 1 commit intocli:trunkfrom
embano1:patch-1
Apr 20, 2021
Merged

Add note on supported value types in raw-fields#3400
mislav merged 1 commit intocli:trunkfrom
embano1:patch-1

Conversation

@embano1
Copy link
Contributor

@embano1 embano1 commented Apr 12, 2021

Proposing a slight amendment to the gh api field docs to clarify the current limitation around "complex" field values, e.g. arrays/objects.

Related: #1484

@embano1
Copy link
Contributor Author

embano1 commented Apr 12, 2021

It would be great if someone can validate this statement is also accurate for objects.

@mislav
Copy link
Contributor

mislav commented Apr 12, 2021

Thank you for the contribution!

This is true, we currently don't support JSON arrays or nested objects. This is not documented, but implied from the omission of said functionality. The workaround is to prepare the raw JSON payload yourself and pass it in via --input.

We plan to support JSON arrays/nested objects in the future: #1484. Because of this, I would rather not add this notice just yet, since it's going to become obsolete soon.

@mislav mislav closed this Apr 12, 2021
@mislav mislav reopened this Apr 12, 2021
Proposing a slight amendment to the `gh api` field docs to clarify the current limitation around "complex" field values, e.g. arrays/objects.

Related: cli#1484
Signed-off-by: Michael Gasch <mgasch@vmware.com>
Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

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

Thank you!

@mislav mislav merged commit a3a7dea into cli:trunk Apr 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants