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 see API stable release specifications #139

Closed
2 tasks done
tloubrieu-jpl opened this issue Dec 2, 2021 · 1 comment · Fixed by #159
Closed
2 tasks done

As a user, I want to see API stable release specifications #139

tloubrieu-jpl opened this issue Dec 2, 2021 · 1 comment · Fixed by #159
Assignees
Labels
B12.1 Epic p.must-have requirement the current issue is a requirement

Comments

@tloubrieu-jpl
Copy link
Member

tloubrieu-jpl commented Dec 2, 2021

💪 Motivation

...so that I can see not only the specification under development but also the latest stable releases and the previous ones.

📖 Additional Details

The requires:

  • propose an organization of the website enabling multiple versions nasa-pds.github.io/pds-api
  • implement the stable release github action

Keep an opening on how to combine multiple application API (e.g. registry + doi)

⚖️ Acceptance Criteria

Given a stable release of the API specification
When I perform a request on url http://nasa-pds.github.io/pds-api/{to be defined, contains X.Y.Z}
Then I expect I can see the stable API specification X.Y.Z

Given
When I perform a request on url http://nasa-pds.github.io/pds-api/
Then I expect I can see pointer to all the history of pds API specifications

⚙️ Engineering Details

@tloubrieu-jpl
Copy link
Member Author

Now the API specifications are presented in a sphinx read the doc web site on gh-pages.

Every applications (registry, doi) and version are stored in a single directory (specs) and the documentation can be generated automatically.

The standard roundup cicd should work (not tested since we are on a feature branch).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B12.1 Epic p.must-have requirement the current issue is a requirement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants