feat: Standardize API client endpoint structure and method naming - #55
Merged
Conversation
This commit introduces a significant refactoring of the API client to enhance consistency and improve developer experience.
Key changes include:
* **Flattened Endpoint Hierarchy**: Many endpoints previously nested under `accounts()` or `zones()` (e.g., `pageRules`, `firewallRules`, `R2` related services, `loadBalancers`, `dns`, `dnssec`) are now accessible directly from the `Client` object, simplifying access and discovery.
* **Consistent Method Naming**:
* `details()` methods are renamed to `get()`.
* `update()` methods for partial resource updates are renamed to `edit()`.
* `overwrite()` methods for full resource replacements are renamed to `update()`.
* `get()` methods used for listing collections are renamed to `list()`.
* **Helper Methods**: Added `scopePath()` to `AbstractEndpoint` for consistent handling of account- or zone-scoped resources, and `jurisdictionHeader()` for R2-specific requests.
* Updated documentation, examples, and tests to reflect the new structure and method names.
This refactoring aims to make the Cloudflare SDK more intuitive and aligned with common RESTful API client conventions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces a significant refactoring of the API client to enhance consistency and improve developer experience.
Key changes include:
accounts()orzones()(e.g.,pageRules,firewallRules,R2related services,loadBalancers,dns,dnssec) are now accessible directly from theClientobject, simplifying access and discovery.details()methods are renamed toget().update()methods for partial resource updates are renamed toedit().overwrite()methods for full resource replacements are renamed toupdate().get()methods used for listing collections are renamed tolist().scopePath()toAbstractEndpointfor consistent handling of account- or zone-scoped resources, andjurisdictionHeader()for R2-specific requests.This refactoring aims to make the Cloudflare SDK more intuitive and aligned with common RESTful API client conventions.