Skip to content

Render discriminated object arrays in props#572

Merged
andrii-balitskyi merged 26 commits into
mainfrom
andrii/cx-298-docs-for-acs_userpending_mutations-not-generating
May 8, 2025
Merged

Render discriminated object arrays in props#572
andrii-balitskyi merged 26 commits into
mainfrom
andrii/cx-298-docs-for-acs_userpending_mutations-not-generating

Conversation

@andrii-balitskyi

Copy link
Copy Markdown
Contributor
  • Add a new line after property-collapsible in api-resource partial
  • Render array props of discriminated objects

@andrii-balitskyi

andrii-balitskyi commented May 6, 2025

Copy link
Copy Markdown
Contributor Author

Initial version of an idea for how to represent arrays of discriminated objects

CC @razor-x @DebbieAtSeam

image

@DebbieAtSeam

Copy link
Copy Markdown
Contributor

@andrii-balitskyi That looks nice! However, I think that folks would prefer a more concise version of what you're proposing. Perhaps the list of possible variants is unnecessary because you have the info. in the tabs (which is a great idea!).

@DebbieAtSeam

Copy link
Copy Markdown
Contributor

Also, I don't think that you need the sentence about "The items in this list are objects." I think that the next sentence is sufficient.

@DebbieAtSeam

Copy link
Copy Markdown
Contributor

You could take the first two paragraphs and combine them. Then, you could take the intro. to the tabs and change it to just "Variants:" or something like that.

@DebbieAtSeam

Copy link
Copy Markdown
Contributor

Hmmm... I do like the tabs, but how do we handle the tab labels getting truncated? I wonder if we need to switch from the tabs to something simpler like an expandable block for each variant, unfortunately.

@andrii-balitskyi

Copy link
Copy Markdown
Contributor Author

@DebbieAtSeam It seems that we can't control tab labels being truncated; GitBook does it automatically. I'll try the expandable block with more concise content.

@andrii-balitskyi

andrii-balitskyi commented May 7, 2025

Copy link
Copy Markdown
Contributor Author

@DebbieAtSeam What do you think about this:

@DebbieAtSeam

Copy link
Copy Markdown
Contributor

@DebbieAtSeam What do you think about this:

@andrii-balitskyi Excellent! Thanks!

@andrii-balitskyi andrii-balitskyi marked this pull request as ready for review May 8, 2025 11:25
@andrii-balitskyi andrii-balitskyi requested review from a team as code owners May 8, 2025 11:25
@andrii-balitskyi andrii-balitskyi merged commit 7638f30 into main May 8, 2025
14 checks passed
@andrii-balitskyi andrii-balitskyi deleted the andrii/cx-298-docs-for-acs_userpending_mutations-not-generating branch May 8, 2025 11:43
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.

3 participants