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

[FEAT] Beta paginated_api_keys function #334

Merged
merged 6 commits into from
Mar 28, 2024
Merged

[FEAT] Beta paginated_api_keys function #334

merged 6 commits into from
Mar 28, 2024

Conversation

nwithan8
Copy link
Member

Description

  • Adds new function paginated_api_keys to User to return a paginated list of API keys, rather than unpaginated from api_keys

NOTE: This beta function exists in the GA User class rather than in a separate Beta\User class because this method is an instance method. It would only be accessible on Beta\User objects, which wouldn't have any other of the existing functions that exist on the User object. They would either have to be entirely re-implemented or a converter between User and Beta\User would have to be introduced; both strategies would add extra overhead and require changes to the end-user's workflow.

More recent major versions of our library have effectively removed this issue by our re-architecture into services that make it easier to separate beta functions from GA functions. For now, a docstring has been added warning users that this new function is in beta.

Testing

  • Add unit test to confirm/validate data coming back from new function/endpoint, test pagination capabilities
  • Add cassette

Pull Request Type

Please select the option(s) that are relevant to this PR.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Improvement (fixing a typo, updating readme, renaming a variable name, etc)

- Clarify difference between `paginated_api_keys` and `api_keys` in docstrings
- Add unit test, cassette
- Clarify difference between `paginated_api_keys` and `api_keys` in docstrings
- Add unit test, cassette
@nwithan8 nwithan8 requested a review from a team as a code owner March 26, 2024 23:51
@nwithan8
Copy link
Member Author

nwithan8 commented Mar 27, 2024

CI is failing because security scan is failing because it's trying to install the latest version of roave/security-advisories which conflicts with sub-dependency requirements, likely due to EOL PHP version support.

roave/security-advisories does not offer any tagged version of its library other than dev-latest, so we can't "pin an older version" to overcome this issue.

@nwithan8 nwithan8 merged commit 72a2e17 into v5 Mar 28, 2024
5 checks passed
@nwithan8 nwithan8 deleted the api_key_beta branch March 28, 2024 20:32
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.

3 participants