Skip to content

Editing API Reference

janiksam edited this page Apr 6, 2023 · 3 revisions

In this section, we'll define the steps to contribute to our API Reference.

OpenAPI

The API Reference is based on an OpenAPI specification that defines the endpoints and request/response schemas.

Review Phase

Specific Issues have been created that are associated with an endpoint and provide general guidance on what to pay attention to while reviewing the endpoint. To provide feedback during the review phase, please submit comments to the issue titled with the specific endpoint name. If you have examples that you would like to share (both request and response bodies), feel free do do so following GitHub-flavored markdown.

Submit issue in GitHub

One way to suggest an update or provide feedback is directly in GitHub by submitting a bug report in Issues. Screenshot 2023-04-06 at 09 39 23

Clone this wiki locally