As a user, I want to get directions whenever I arrive on an API URL

[tloubrieu-jpl]

💪 Motivation

...so that I can use the API efficiently, without having to navigate into the full documentation.

📖 Additional Details

Currently:
https://pds.nasa.gov/api --> unavailable
https://pds.nasa.gov/api/search --> unavailable
https://pds.nasa.gov/api/search/1.0 --> pds home page

Proposal:
https://pds.nasa.gov/api --> https://nasa-pds.github.io/pds-api/ , create specific page which lists all the deployments
https://pds.nasa.gov/api/search/ --> https://nasa-pds.github.io/pds-api/search , create specific page which lists all the available versions for this service
https://pds.nasa.gov/api/doi/ --> migrate redirection to cloud-front + create page.
https://pds.nasa.gov/api/search/1.0 --> redoc page

• create landing page for all APIs
• create landing page for search API deployments
• create landing page for DOI API deployments
• make redirection from cloud front to Search landing pages and general API landing page
• make redirection from apache to DOI landing pages

Future
Create a different tickets for the rebranding of the swagger pages in registry and doi.
Create a ticket for migrating redirection of DOI API to cloud-front (after everything works on Apache)

References:
look at what CMR does ?

⚖️ Acceptance Criteria

Given
When I perform
Then I expect

⚙️ Engineering Details

[tloubrieu-jpl]

@jimmie I have been able to look at this ticket. For the redirections you can use:

https://pds.nasa.gov/api --> https://nasa-pds.github.io/pds-api/overview.html (this page is going to be improved with PR #201)

https://pds.nasa.gov/api/search/ --> https://pds.nasa.gov/api/search/1.0

https://pds.nasa.gov/api/doi/ --> https://pds.nasa.gov/api/doi/0.2

https://pds.nasa.gov/api/search/1.0 --> https://nasa-pds.github.io/pds-api/specifications/search-v1.0.0-redoc.html (while swagger cannot be opened)

https://pds.nasa.gov/api/doi/0.2 --> https://nasa-pds.github.io/pds-api/specifications/doi-v0.2-redoc.html (while swagger cannot be opened)

This might not be exactly what we said during the meeting but I took a pragmatic approach (with less new pages)

[jimmie]

@tloubrieu-jpl - rules have been put in place that perform these redirects. Can you test to verify?

[tloubrieu-jpl]

Perfect, thanks @jimmie

[tloubrieu-jpl]

@gxtchen this need to be tested from the production deployed links.
https://pds.nasa.gov/api --> https://nasa-pds.github.io/pds-api/overview.html
https://pds.nasa.gov/api/search/ --> https://pds.nasa.gov/api/search/1.0
https://pds.nasa.gov/api/doi/ --> https://pds.nasa.gov/api/doi/0.2
https://pds.nasa.gov/api/search/1.0 --> https://nasa-pds.github.io/pds-api/specifications/search-v1.0.0-redoc.html
https://pds.nasa.gov/api/doi/0.2 --> https://nasa-pds.github.io/pds-api/specifications/doi-v0.2-redoc.html