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

[DOCS] There should be a connection in between request examples in API Reference #1300

Open
ucatbas opened this issue Jun 6, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation iteration Improvement on an existing feature

Comments

@ucatbas
Copy link
Contributor

ucatbas commented Jun 6, 2024

Context

In the API Reference section of documentation, the relationships between the requests should be clearly connected.

Current Behavior

  • To make it easier to follow and understand, it would be helpful to have a storyline that connects the requests in the documentation. For instance, the schema provided under write schema request doesn't match the data under write data request.
  • Also, there's a minor bug in the cURL example for the list schemas request; the request shown is for read schema instead.

Expected Behavior

  • The API reference includes an example schema request with a specific body. The authorization data request example's body should match this schema body example. This consistency should apply to all request examples in the API reference.
  • All cURL examples in the documentation should accurately reflect their corresponding requests.
@ucatbas ucatbas added the bug Someting isn't working label Jun 6, 2024
@ucatbas ucatbas added the documentation Improvements or additions to documentation label Jun 6, 2024
@tolgaOzen tolgaOzen added iteration Improvement on an existing feature and removed bug Someting isn't working labels Aug 11, 2024
@tolgaOzen tolgaOzen changed the title [BUG] [DOCS] There should be a connection in between request examples in API Reference [DOCS] There should be a connection in between request examples in API Reference Aug 11, 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 iteration Improvement on an existing feature
Projects
Status: Q3 2024 – Jul-Sep
Development

No branches or pull requests

3 participants