Skip to content

Commit 0755119

Browse files
docs: this commit introduces section for accessing open api specification via /scalar endpoint
1 parent 86c6a12 commit 0755119

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

Documentation/rest-reference.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,11 @@ Our API is fully documented using the **OpenAPI 3 (OAS3) standard**.
4343
This means you can explore all available endpoints, request/response schemas requirements programmatically or using tools like **Swagger UI**, **Postman**, or any OpenAPI-compatible client.
4444

4545
You can access the OpenAPI JSON directly at: `https://<your-host>/openapi/v1.json`
46+
47+
# Accessing the OpenAPI Specification via /scalar
48+
49+
You can also access and interact with the OpenAPI documentation using the `/scalar` endpoint:
50+
51+
- `https://<your-host>/scalar`
52+
53+
This endpoint provides a user-friendly interface for exploring, testing, and visualizing all available API endpoints and schemas directly in your browser. Tools like Swagger UI or Scalar UI can be used for this purpose, making integration and discovery even easier for developers.

0 commit comments

Comments
 (0)