Skip to content

Commit

Permalink
minor fix
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas loubrieu committed Sep 4, 2024
1 parent f47fa29 commit 0b3bc48
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 7 deletions.
10 changes: 8 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
project = 'PDS APIs'
copyright = '2022 California Institute of Technology'
author = 'NASA Planetary Data System'
release = 'B14.0'
version = 'B14.0'
release = 'B15.0'
version = 'B15.0'


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -73,6 +73,12 @@
redoc_uri = 'https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js'

redoc = [
{
'name': 'PDS Search API',
'page': 'specifications/search-v1.5.0-redoc',
'spec': '../../specs/PDS_APIs-search-1.5.0-swagger.yaml',
'embed': True,
},
{
'name': 'PDS Search API',
'page': 'specifications/search-v1.4.0-redoc',
Expand Down
1 change: 1 addition & 0 deletions docs/source/guides/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The PDS Search API provides endpoints:
* to **resolve** an identifier (lid or lidvid) and retrieve the product label and data where ever it is in the Planetary Data System.

For an introduction to the Search API and what it's capable of, checkout these slides and a presentation given at the 2022 PSIDA conference:

* Slides: https://www.cosmos.esa.int/documents/6109777/9316710/X03+-+Padams+-+NASA_Planetary_Data_System_Search_API.pdf
* Presentation Recording: https://www.cosmos.esa.int/web/psida-2022/-/x03

Expand Down
3 changes: 0 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
PDS APIs
========

.. attention::
The PDS Search API (https://pds.nasa.gov/api/search/) will be down will be down for maintenance for 2-3 weeks beginning May 6, 2024 at 8am Pacific Time. Limited functionality will be released as it becomes available. Apologies for the inconvenience. Please contact the PDS Help Desk if you have any questions.

The Planetary Data System (PDS) is a federated system of nodes that archive planetary science data.

The PDS Application Programming Interface (API) provides a consistent way for planetary science community to discover and
Expand Down
4 changes: 2 additions & 2 deletions docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The PDS API base urls are provided under the following pattern:
where:

- ``{service}``: the service such as ‘search’ (i.e. registry), ‘doi’, etc.. This component can have an optional node identifier (e.g. ‘search-geo’). Absence of a node implies EN.
- ``{service}``: the service such as ‘search’ (in registry), ‘doi’, etc..
- ``{version}``: the version of the service.
- ``{service_path+params}``: the ReST path for the service, including any query parameters - this is essentially the remaining portion of the URI after the version.

Expand All @@ -18,7 +18,7 @@ API entries currently available are:
+----------+-----------+-------------------------+----------------+-----------------+
| service | version | scope | specification | user's guide |
+==========+===========+=========================+================+=================+
| search | 1.1 | search PDS data archive | `search_spec`_ | `search_guide`_ |
| search | 1.5 | search PDS data archive | `search_spec`_ | `search_guide`_ |
+----------+-----------+-------------------------+----------------+-----------------+
| doi | 0.2 | manage PDS DOIs | `doi_spec`_ | |
+----------+-----------+-------------------------+----------------+-----------------+
Expand Down
1 change: 1 addition & 0 deletions docs/source/specifications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Specifications

Each published version of NASA PDS APIs is documented here:

- `Search API v1.5.0 <specifications/search-v1.5.0-redoc.html>`_
- `Search API v1.4.0 <specifications/search-v1.4.0-redoc.html>`_
- `Search API v1.3.0 <specifications/search-v1.3.0-redoc.html>`_
- `Search API v1.1.1 <specifications/search-v1.1.1-redoc.html>`_
Expand Down

0 comments on commit 0b3bc48

Please sign in to comment.