NASA PDS federated API

This repo is the entry point for the NASA PDS federated API specifications.

The specifications are discussed in the PDS Working Group and a first level of specification is shared on google drive.

The formal specification in Open API standard is shared on swaggerHub: https://app.swaggerhub.com/apis/PDS_APIs/pds_federated_api/0.1.dev

Various implementation flavour are also being made available:

API Documentation

The API Documentation is generated in github action workflow on:

A draft of the PDS API Specification can be found on Google Drive:

POSTMAN is a popular tool to make web API testing more user friendly: https://www.postman.com/

POSTMAN is a standalone desktop application that you first need to download and install: https://www.postman.com/downloads/

To create a test collection for the PDS federated API, the steps are:

go to import (top-left)
choose 'Link' tab
Use link https://raw.githubusercontent.com/NASA-PDS/pds-api/master/json-unresolved/swagger.json
In settings, for request parameter generation, select Example, this will assign example values to the API arguments. If you select Schema no value will be assigned.
Create a virtual environment: click the wheel on top-right, then 'Add'
Create constant baseUrl and assign value of your root server without trailing /, for example https://pds-gamma.jpl.nasa.gov/api
Make sure your new environment is selected, use top-right drop down menu.
In the left menu, go to your new collection folder named Planetary Data System API, select a request.
Adjust the request's parameters and hit Send
You can extend the collection by duplicating and editing existing requests

Warning: if you reimport the same specification in the same folder, your manually set parameters will be lost.