Skip to content

Commit

Permalink
publish: Update changelog
Browse files Browse the repository at this point in the history
generated from commit 9cb4dde
  • Loading branch information
pdsen-ci committed Oct 13, 2022
1 parent 8fb6f0e commit f540de1
Show file tree
Hide file tree
Showing 86 changed files with 3,295 additions and 13,311 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8d1149b88aa776f4ffcaf8f74ca5f703
config: 1abd5d55bc8e4813c6a54d66312ce1a7
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/acknowlegements.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/general-conventions.doctree
Binary file not shown.
Binary file added .doctrees/guides/search.doctree
Binary file not shown.
Binary file added .doctrees/guides/search/cookbook.doctree
Binary file not shown.
Binary file added .doctrees/guides/search/endpoints.doctree
Binary file not shown.
Binary file added .doctrees/guides/search/quickstart.doctree
Binary file not shown.
Binary file added .doctrees/guides/search/response_formats.doctree
Binary file not shown.
Binary file added .doctrees/guides/search/tutorials.doctree
Binary file not shown.
Binary file removed .doctrees/implementations.doctree
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
Binary file modified .doctrees/overview.doctree
Binary file not shown.
Binary file modified .doctrees/specifications.doctree
Binary file not shown.
Binary file modified .doctrees/support.doctree
Binary file not shown.
Binary file modified .doctrees/support/contact.doctree
Binary file not shown.
Binary file modified .doctrees/support/contribute.doctree
Binary file not shown.
Binary file added .doctrees/support/discussions.doctree
Binary file not shown.
Binary file added .doctrees/tools.doctree
Binary file not shown.
11 changes: 0 additions & 11 deletions .gitignore

This file was deleted.

1 change: 0 additions & 1 deletion _sources/acknowlegements.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ PDS API Working Group
* Vivian Tang (EN)
* Al Niessner (EN)
* Ramesh Maddegoda (EN)
* Yevgen Karpenko (EN)
* Thomas Loubrieu (EN)
* Jordan Padams (EN)
* Boris Semenov (NAIF)
2 changes: 1 addition & 1 deletion _sources/general-conventions.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ heterogeneous in the PDS system.
Two options have been considered to manage versions (see
`https://restfulapi.net/versioning/ <https://restfulapi.net/versioning/>`_ :

- Version in the URL, e.g. pds.nasa.gov/api/search/1.0/
- Version in the URL, e.g. pds.nasa.gov/api/search/|search_user_guide_api_version|/

- Content negotiation headers (e.g. Accept: application/vnd.example+json;version=1.0)

Expand Down
172 changes: 0 additions & 172 deletions _sources/general_conventions.rst.txt

This file was deleted.

2 changes: 1 addition & 1 deletion _sources/guides/search.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ These pages provide a user guide for the PDS Search API.
search/endpoints
search/response_formats
search/tutorials
API Full Reference <https://nasa-pds.github.io/pds-api/specifications/search-v1.0.0-redoc.html>
API Full Reference <https://nasa-pds.github.io/pds-api/specifications/search-v1.1.0-redoc.html>
72 changes: 54 additions & 18 deletions _sources/guides/search/cookbook.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Search for the 10 latest collections which processing level is "Raw":
:caption: curl command
:substitutions:
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/collections' \
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/classes/collections' \
--data-urlencode 'limit=10' \
--data-urlencode 'q=(pds:Primary_Result_Summary.pds:processing_level eq "Raw")'
Expand All @@ -84,7 +84,7 @@ Search for all Observational Products targeting Bennu:
:caption: curl command
:substitutions:
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/collections' \
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/classes/collections' \
--data-urlencode 'q=(ref_lid_target eq "urn:nasa:pds:context:target:asteroid.101955_bennu")'
----
Expand All @@ -107,40 +107,41 @@ See the documentation on `Citing PDS Data <https://pds.nasa.gov/datastandards/ci
How to Find the DOI associated with an Observational Product
------------------------------------------------------------

We assume you know the identifier of the product you are working with. In our example it is: ``urn:nasa:pds:insight_rad:data_derived:hp3_rad_der_00014_20181211_073042::1.0``
We assume you know the identifier of the product you are working with but a couple are provided in the examples below.


Search for a Products Collection DOI
************************************

Run the following request to get the DOI associated with the product's collection:
Run the following request to get the DOI associated with the collection the observational product `urn:nasa:pds:compil-comet:nuc_properties:description::1.0` belongs to:

.. code-block:: bash
:substitutions:
:caption: curl command
:substitutions:
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/products/urn:nasa:pds:insight_rad:data_derived:hp3_rad_der_00014_20181211_073042::1.0/collections' \
--data-urlencode 'fields=ops:Identifiers/ops:doi' \
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/products/urn:nasa:pds:compil-comet:nuc_properties:description::1.0/member-of' \
--data-urlencode 'fields=pds:External_Reference.pds:doi' \
--header 'Accept: application/kvp+json'
.. _DOI request result:
.. _DOI collection request result:

You will get the following result:

.. code-block:: json
{
"summary": {
"summary" : {
"q": "",
"hits": 1,
"took": 172,
"took": 125,
"start": 0,
"limit": 100,
"sort": [],
"properties": []
"properties": ["pds:External_Reference.pds:doi"]
},
"data": [
{
"ops:Identifiers/ops:doi": "10.17189/1517568"
"pds:External_Reference.pds:doi":"10.26007/CSR5-JW43"
}
]
}
Expand All @@ -150,16 +151,51 @@ Note that you might not find any DOI at the collection level, in this case you c
Search for a Product's Bundle DOI
*********************************

To get the DOI associated with the bundle the observational product `urn:nasa:pds:insight_rad:data_derived:hp3_rad_der_00014_20181211_073042::1.0` belongs to:
To get the DOI associated with the bundle the observational product `urn:nasa:pds:insight.spice:document:spiceds::1.0` belongs to:

.. code-block:: bash
:substitutions:
:caption: curl command
:substitutions:
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/products/urn:nasa:pds:insight_rad:data_derived:hp3_rad_der_00014_20181211_073042::1.0/bundles' \
--data-urlencode 'fields=pds:Citation_Information/pds:doi,ops:Identifiers/ops:doi' \
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/products/urn:nasa:pds:insight.spice:document:spiceds::1.0/member-of/member-of' \
--data-urlencode 'fields=pds:Citation_Information/pds:doi,pds:External_Reference.pds:doi' \
--header 'Accept: application/kvp+json'
You will get the same response as for a :ref:`collection request <Search for a Products Collection DOI>`
.. _DOI bundle request result:

You will get the following result:

.. code-block:: json
{
"summary" : {
"q": "",
"hits": 2,
"took": 135,
"start": 0,
"limit": 100,
"sort": [],
"properties": [
"pds:Citation_Information.pds:doi",
"pds:External_Reference.pds:doi"
]
},
"data": [
{ },
{
"pds:External_Reference.pds:doi": "[
10.1007/s11214-018-0563-9,
10.1007/s11214-018-0570-x,
10.1007/s11214-018-0531-4,
10.1007/s11214-018-0530-5,
10.1007/s11214-018-0574-6,
10.1007/s11214-018-0536-z,
10.1007/s11214-018-0520-7
]",
"pds:Citation_Information.pds:doi": "10.17189/1517566"
}
]
}
How to Find the PDS Product Associated with a DOI
Expand All @@ -171,7 +207,7 @@ To get the PDS product metadata associated with a the DOI `10.17189/1517568`:
:substitutions:
curl --get 'https://pds.nasa.gov/api/search/|search_user_guide_api_version|/products' \
--data-urlencode 'q=(ops:Identifiers/ops:doi eq "10.17189/1517568")' \
--data-urlencode 'q=(pds:External_Reference.pds:doi eq "10.26007/CSR5-JW43")' \
--header 'Accept: application/json'
You will get a JSON response of the PDS products (any class of product, for example collections or bundles) which have referenced the given DOI.
Expand Down
Loading

0 comments on commit f540de1

Please sign in to comment.