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

refactor(paginated): add common interface for paginated calls #453

Merged
merged 2 commits into from
May 16, 2022

Conversation

louis-bompart
Copy link
Contributor

Created a 'base' interface for the list calls.

This interface for now excludes some outliers, Snapshot & Catalog, because the REST APIs are not following the historic standard of perPage for the number of items per page.

We could (in another PR to keep the scope accurate) expose a perPage argument that would be used as an alias for their equivalent.

Tips for review, ignore whitespace... We had a discussion on Slack about that, will be normalized 🔜 ™️

Acceptance Criteria

  • JSDoc annotates each property added in the exported interfaces: kept the JSDOC of the existing, left the other as is.
  • The proposed changes are covered by unit tests: refactor only
  • Commits containing breaking changes a properly identified as such: N.A.
  • README.md is adjusted to reflect the proposed changes (if relevant): N.A.

@louis-bompart louis-bompart requested a review from a team as a code owner May 10, 2022 22:22
@louis-bompart louis-bompart requested review from olamothe, a team, GermainBergeron, FelixBlaisThon and sallainCoveo and removed request for a team May 10, 2022 22:22
@louis-bompart louis-bompart requested a review from toofff May 12, 2022 19:00
@@ -1,5 +1,4 @@
# Logs
logs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Otherwise, src/resources/Logs get ignored. 🤣

@louis-bompart louis-bompart merged commit ff9598b into master May 16, 2022
@louis-bompart louis-bompart deleted the refactor/CDX-958 branch May 16, 2022 14:12
@coveobot
Copy link

🎉 This PR is included in version 30.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

6 participants