-
Notifications
You must be signed in to change notification settings - Fork 145
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
Comments
Hello. |
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. |
@ElliotFriend which PR was it that ended up implementing the OpenAPI? This is the first time I've seen it used on an intimate level, and would love to explore the path-routing specs for #723. |
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?Given the amount of information concealed here is so minimal, I really think it should get displayed as a simple sub-list. 🖥️
stellar-docs/docs/data/horizon/api-reference/resources/offers/object.mdx
Lines 37 to 42 in 7b5567b
Moreover, the verbose
Show child attributes
phrase adds practically as much requite reading as the fundamentally-crucial numerator and denominator definitions themselves. 🧐The text was updated successfully, but these errors were encountered: