Skip to content

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

Open
@ucatbas

Description

@ucatbas

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.

Metadata

Metadata

Labels

documentationImprovements or additions to documentationiterationImprovement on an existing feature

Type

No type

Projects

Status

Q3 2024 – Jul-Sep

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions