Skip to content

Commit 98c8359

Browse files
committed
Add a reference to the REST API
1 parent 9880583 commit 98c8359

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

doc/Caterva2.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,14 @@ On demand access to remote Blosc2 data repositories.
5656
:color: dark
5757
:click-parent:
5858

59-
To the API reference
59+
To the Python API reference
60+
61+
.. button-ref:: reference/rest_api
62+
:expand:
63+
:color: dark
64+
:click-parent:
65+
66+
To the REST API reference
6067

6168
.. grid-item-card::
6269
:img-top: _static/index_contribute.svg
@@ -83,7 +90,8 @@ On demand access to remote Blosc2 data repositories.
8390

8491
Getting Started <getting_started/index>
8592
Tutorials <tutorials/index>
86-
API Reference <reference/index>
93+
Python API Reference <reference/index>
94+
REST API Reference <reference/rest_api>
8795
Utilities <utilities/index>
8896
Development <development/index>
8997
Release Notes <release_notes/index>

doc/reference/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ API Reference
99
file_class
1010
dataset_class
1111
utils
12-
.. subscriber_class # TODO: how to document the REST API?

doc/reference/rest_api.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
REST API Reference
2+
==================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
A REST API is provided by the Caterva2 server. It is a simple HTTP API that allows you to interact with the Caterva2 server using standard HTTP methods. The API is designed to be easy to use and understand, and it provides a simple way to access the functionality of the Caterva2 server from any programming language that can make HTTP requests.
8+
9+
The most updated version of the REST API is available at https://cat2.cloud/demo/docs.
10+
11+
It is important to note that the REST API is not intended to be used as a replacement for the :doc:`Caterva2 Python client API <index>`. The Python client API provides a more convenient and efficient way to interact with the Caterva2 server, and it is recommended for most use cases. However, the REST API can be useful in certain situations, such as when you need to access the Caterva2 server from a programming language that does not have a Caterva2 client library, or when you need to integrate Caterva2 with other systems that use HTTP.

0 commit comments

Comments
 (0)