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

326 remove "products" from exposed classes #328

Merged
merged 8 commits into from
May 1, 2023

Conversation

alexdunnjpl
Copy link
Contributor

🗒️ Summary

Per @tloubrieu-jpl in #326, "products" is confusing when overloaded to describe "products which are not aggregate products.

This PR removes 'products' from the results returned by endpoint /classes, and removes it as a enumerated class value for endpoint /classes/{class}.

It also performs significant renaming of related concepts within the API, specifically:

Relevant Product-prefixed classes classes are now named with NonAggegateProduct prefix instead.
GroupConstraint methods any(), all() and not() have been renamed to filter(), must() and mustNot(). These new names directly reflect the search concepts they conceptually map to, and should avoid confusion in future.

A method union() is implemented for GroupConstraint and later reverted. I haven't written unit tests for it and can't be bothered since it ended up not being required, but it's left in the commit history just in case a use-case for it comes up in future.

⚙️ Test Data and/or Report

Postman tests pass. Postman tests written and PR will be opened to add them to the registry repo's tests

♻️ Related Issues

fixes #326

@alexdunnjpl
Copy link
Contributor Author

Oh, and I deleted the obsolete/non-maintained postman tests file and replaced it with a readme so devs can find the real one.

@alexdunnjpl alexdunnjpl merged commit f604e07 into main May 1, 2023
@alexdunnjpl alexdunnjpl deleted the 326-no-more-products-confusion branch May 1, 2023 16:42
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.

Remove the 'products' in the /classes
2 participants