Skip to content

Commit

Permalink
Small changes
Browse files Browse the repository at this point in the history
  • Loading branch information
anamanica committed Aug 14, 2024
1 parent 8952a5a commit 1182258
Showing 1 changed file with 2 additions and 18 deletions.
20 changes: 2 additions & 18 deletions docs/source/data-access-api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ The SDC further provides a REST API that allows users to upload and download fil
well as query for file metadata. The following documentation describes the
various endpoints that are supported and how to use them.

The following documentation covers both functionalities starting with the CLI use, and moving to the REST API usage afterwards.

*Note: Several sections and links begin with* [WIP]. *As development on the API is ongoing, this indicates
that the full implementation of the functionality is yet to be completed.*

Expand All @@ -23,7 +21,7 @@ Command Line Utility
To Install
----------

Run the following command to use the data access API CLI.
Run the following command to use the API CLI.

.. code-block:: bash
Expand All @@ -32,7 +30,7 @@ Run the following command to use the data access API CLI.
Base Command Arguments
----------------------

The following are the base command arguments for the CLI:
The following are base command arguments for the CLI:

.. code-block:: bash
Expand All @@ -43,11 +41,6 @@ The following are the base command arguments for the CLI:
Add the -h flag with any base command for more information on use and functionality.

Query to search for data
------------------------

You can search for files in the database using the command ``query`` and different parameters either alone or in conjunction with each other.

.. openapi:: openapi.yml
:group:
:include: /query
Expand All @@ -60,10 +53,6 @@ You can search for files in the database using the command ``query`` and differe
# The following line is returned:
[{'file_path': 'imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts', 'instrument': 'swe', 'data_level': 'l0', 'descriptor': 'sci', 'start_date': '20240105', 'version': 'v001', 'extension': 'pkts'}, {'file_path': 'imap/swe/l0/2024/01/imap_swe_l0_sci_20240105_v001.pkts', 'instrument': 'swe', 'data_level': 'l0', 'descriptor': 'sci', 'start_date': '20240105', 'version': 'v001', 'extension': 'pkts'}]
Download a file
---------------

You can download files form the database using the command ``download``.
.. openapi:: openapi.yml
:group:
Expand All @@ -82,11 +71,6 @@ organize the downloaded files. See the example path: ``data/imap/swe/l0/2024/01/
imap-data-access upload /imap/swe/l1a/2024/01/imap_swe_l1a_sci_20240105_v001.cdf
Upload a file
-------------

Similarly, you may upload a file to the data base using the command ``upload``.

.. openapi:: openapi.yml
:group:
:include: /upload
Expand Down

0 comments on commit 1182258

Please sign in to comment.