Skip to content

feat: added support for returning total number of results in new Audit.SearchAll method#493

Merged
dorsha merged 2 commits intomainfrom
add-total-return-value-to-audit-search
Jan 12, 2025
Merged

feat: added support for returning total number of results in new Audit.SearchAll method#493
dorsha merged 2 commits intomainfrom
add-total-return-value-to-audit-search

Conversation

@yosiharan
Copy link
Contributor

@yosiharan yosiharan commented Jan 9, 2025

Description

Resolves: https://github.com/descope/etc/issues/8887

Added a new Audit.SearchAll API which also returns the total number of search results, same as in the User.SearchAll API. Marked the existing Audit.Search method as Deprecated.

Additional minor fixes:

  1. feat: renamed option to set paging size by using the Limit option instead of the Size option to adhere to the same API used in User.SearchAll (breaking change, but breaks a new API which is not in use yet, so not worth "dirtying" the API with unneeded backwards compatibility aliases)
  2. chore: added files generated by running the local example to be ignored by gitleaks to avoid false leaks from appearing in pre-commit hooks

Must

  • Tests
  • Documentation (if applicable)

…chAll method

feat: renamed option to set paging size by using the Limit option instead of the Size option (breaking but not in use yet by clients so not worth "dirtying" the API with unneeded aliases)
chore: added files generated by running the local example to be ignored by gitleaks to avoid false leaks from appearing in pre-commit hooks
@yosiharan yosiharan requested a review from dorsha January 9, 2025 14:04
Copy link
Member

@dorsha dorsha left a comment

Choose a reason for hiding this comment

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

Cool, let's keep old search tests as well

@yosiharan
Copy link
Contributor Author

@dorsha thanks! I re-added the old search tests, ready for review again 🙏

@dorsha dorsha merged commit f0cb3f3 into main Jan 12, 2025
5 checks passed
@dorsha dorsha deleted the add-total-return-value-to-audit-search branch January 12, 2025 14:27
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.

2 participants