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

Use some better HTML/Markdown format structure to show which query response fields are optional #157

Open
thadguidry opened this issue Mar 14, 2024 · 0 comments · May be fixed by #173
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thadguidry
Copy link
Contributor

In the 4.1 section for Query Structures, we say easily that query and properties are required and all other fields are optional.
But in 4.2 section for Query Responses, we have the optional properties within the field description sentences and it's hard to quickly see what is optional or not. Maybe some formatting changes like bold, paratheses, or something to make it easier for developers to quickly scan and read which fields are optional or not.

@thadguidry thadguidry added the documentation Improvements or additions to documentation label Mar 14, 2024
@thadguidry thadguidry self-assigned this Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant