Skip to content
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.

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

📝 Show child attributes diction #978

Open
JFWooten4 opened this issue Sep 13, 2024 · 2 comments
Open

📝 Show child attributes diction #978

JFWooten4 opened this issue Sep 13, 2024 · 2 comments
Assignees

Comments

@JFWooten4
Copy link
Contributor

JFWooten4 commented Sep 13, 2024

Do you think it's intuitive to scroll through the specification to find a box you need to click to see the most basic information about a price_r object?

Screenshot 2024-09-13 at 10 37 51 AM

Given the amount of information concealed here is so minimal, I really think it should get displayed as a simple sub-list. 🖥️

- n
- number
- The numerator.
- d
- number
- The denominator.

Moreover, the verbose Show child attributes phrase adds practically as much requite reading as the fundamentally-crucial numerator and denominator definitions themselves. 🧐

@Epic-SX
Copy link

Epic-SX commented Sep 15, 2024

Hello.
I am interested in issue.
I can complete this issue.
I would appreciate it if you give me opportunity to work with you.

@ElliotFriend
Copy link
Contributor

Hey, there!! You do bring up a good point that the "hiddenness" of the child attributes in this instance doesn't really serve much purpose. I think it's more intuitive what it was meant for on pages like The Claimable Balance Object, where a couple layers of child attributes are nested together.

That said, this will probably be irrelevant in the not-too-distant-future. Soon, we'll be generating these pages out of the OpenAPI spec files, instead of hand-writing them. They'll be displayed similar to this example schema page, and it'll feel a lot like the existing OpenAPI parameter/response sections that are already displayed alongside each of the endpoint pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Ideas
Development

No branches or pull requests

3 participants