Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a user, I want to be able to access the Search API Swagger interface from pds.nasa.gov #442

Closed
jordanpadams opened this issue Jun 9, 2022 · 4 comments
Assignees
Labels
B13.1 Epic p.must-have requirement the current issue is a requirement

Comments

@jordanpadams
Copy link
Member

💪 Motivation

...so that I can easily access, interact with, and prototype various queries with the API.

📖 Additional Details

⚖️ Acceptance Criteria

Given a deployed API and TBD URL
When I perform access to that TBD URL and perform a test query
Then I expect the swagger UI to query the API and get back results, matching what can be done via Curl or other client mechanisms

⚙️ Engineering Details

See sub-tasks for details

@jordanpadams jordanpadams added requirement the current issue is a requirement needs:triage labels Jun 9, 2022
@jordanpadams jordanpadams self-assigned this Jun 9, 2022
@jordanpadams jordanpadams changed the title As a user, I want to be able to access the Swagger interface from pds.nasa.gov As a user, I want to be able to access the Search API Swagger interface from pds.nasa.gov Jun 9, 2022
@gxtchen
Copy link

gxtchen commented Apr 20, 2023

@c-suh @jordanpadams where is the Swagger interface for pds.nasa.gov?

@tloubrieu-jpl
Copy link
Member

@gxtchen the latest version of the registry-api is meant to fix the issues which prevented us from having the swagger-ui on pds.NASA.gov. These issues were:

  • conformance with the NASA web skin
  • ability to work properly being a reverse proxy or AWS cloud front.

For you to test that I need to deploy on en-delta or en-gamme.

@tloubrieu-jpl
Copy link
Member

Hi @gxtchen ,

I deployed the latest registry-api on en-delta, you can get the link here https://pds-en-delta-1955939225.us-west-2.elb.amazonaws.com/ from which you can test the swagger-ui.

@tloubrieu-jpl
Copy link
Member

However I am thinking now it does not fully test the swagger-ui as intended since the application is not behing Cloud front with a specifci url context (e.g. /api/search/1/... ). I would need to deploy on gamma as well.

@jordanpadams jordanpadams transferred this issue from NASA-PDS/pds-api May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B13.1 Epic p.must-have requirement the current issue is a requirement
Projects
None yet
Development

No branches or pull requests

4 participants