@@ -16,6 +16,16 @@ data applications, including but not limited to the following ones:
1616Often, the REST API is used to enable [ embedded analytics] [ cube-ea ] and
1717[ real-time analytics] [ cube-rta ] use cases.
1818
19+ See [ REST API reference] [ ref-ref-rest-api ] for the list of supported API endpoinsts.
20+ Also, check [ query format] [ ref-rest-query-format ] for details about query syntax.
21+
22+ <InfoBox >
23+
24+ You can find a mostly complete OpenAPI documentation for the REST API in the
25+ linked [ ` openspec.yml ` file] [ gh-cube-openspec ] that you can use with tools like Swagger.
26+
27+ </InfoBox >
28+
1929<InfoBox >
2030
2131If you've chosen [ GraphQL] [ graphql ] as a query language for your front-end
@@ -24,10 +34,9 @@ provides.
2434
2535</InfoBox >
2636
27- Under the hood, REST API also provides endpoints for [ GraphQL
28- API] [ ref-graphql-api ] and [ Orchestration API] [ ref-orchestration-api ] . However,
29- they target specific use cases and are not usually considered part of the REST
30- API.
37+ REST API also provides endpoints for [ GraphQL API] [ ref-graphql-api ] and
38+ [ Orchestration API] [ ref-orchestration-api ] . However, they target specific use
39+ cases and are not considered part of the REST API.
3140
3241## Example request
3342
@@ -84,10 +93,6 @@ curl \
8493 http://localhost:4000/cubejs-api/v1/meta | jq
8594```
8695
87- Check [ query format] [ ref-rest-query-format ] for details about supported queries.
88- Also, check [ REST API reference] [ ref-ref-rest-api ] for the list of supported API
89- endpoints.
90-
9196## Configuration
9297
9398REST API is enabled by default and secured using [ API scopes] [ self-api-scopes ]
@@ -291,3 +296,4 @@ example, the following query will retrieve rows 101-200 from the `Orders` cube:
291296[ self-cors ] : #configuration-cors
292297[ ref-ref-rest-api ] : /reference/rest-api
293298[ link-jq-utility ] : https://jqlang.github.io/jq/
299+ [ gh-cube-openspec ] : https://github.com/cube-js/cube/blob/master/packages/cubejs-api-gateway/openspec.yml
0 commit comments