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

Products endpoint doc update #479

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Conversation

alexdunnjpl
Copy link
Contributor

@alexdunnjpl alexdunnjpl commented Jul 10, 2024

🗒️ Summary

Trivial swagger doc update - /products only touches the latest-versioned products, yeah @jordanpadams ?

Applicable requirements

Refs #426

@alexdunnjpl alexdunnjpl changed the base branch from main to develop July 10, 2024 17:57
@jordanpadams
Copy link
Member

@alexdunnjpl I updated the PR to include the requirement. I also updated the requirement success criteria to include more detailed information. all related requirements regarding versioning should be here in the parent theme:

@jordanpadams
Copy link
Member

@alexdunnjpl @tloubrieu-jpl do we think we need separate requirements for each endpoint? or does #426 requirement suffice? In case it is the latter, I will add more success criteria, or I will create some more requirements.

@tloubrieu-jpl
Copy link
Member

@jordanpadams @alexdunnjpl if we eventually have one test per requirement we should have one requirement per end-point. That would simplify the verification of the coverage of the test. But there might be a smarter way to do that...

@tloubrieu-jpl
Copy link
Member

And @alexdunnjpl , we want to add an attribute all-versions at some point, soon, so we will have to change that documentation again.

Copy link
Member

@tloubrieu-jpl tloubrieu-jpl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alexdunnjpl

@alexdunnjpl alexdunnjpl merged commit 17759eb into develop Jul 11, 2024
0 of 2 checks passed
@alexdunnjpl alexdunnjpl deleted the products-endpoint-doc-update branch July 11, 2024 01:07
@jordanpadams
Copy link
Member

@jordanpadams @alexdunnjpl if we eventually have one test per requirement we should have one requirement per end-point. That would simplify the verification of the coverage of the test. But there might be a smarter way to do that...

@tloubrieu-jpl +1 will break tout all the requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants