address-objects #3
Merged
Conversation
This file contains 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
Deleted the outdated .idea/.gitignore file and migrated its contents to the main .gitignore file. This consolidates all ignore rules and improves project configuration clarity.
This commit deletes the .idea/modules.xml file. This change helps to clean up project-specific configuration files not necessary for version control.
The file pan-scm-sdk.iml is specific to IntelliJ IDEA and should not be tracked in the repository. This change helps prevent unnecessary file clutter and potential merge conflicts.
Introduced address, address group, and application endpoints to the `API_ENDPOINTS` dictionary. Defined new custom exception classes: `NotFoundError`, and `ConflictError`. All __init__.py files are also updated to ensure they end with a newline.
Introduce new test cases for `AddressClient` to validate `list_addresses` and `get_address` methods using mock responses. Extend coverage for the `Address` model by testing valid and invalid scenarios related to address types and containers.
Removed the entire `authentication.py` file due to unused exceptions. Enhanced the `AuthRequest` class with better documentation and added a new `AddressClient` class for address management. Additionally, improved error handling in `APIClient` and added logging.
Introduced three new modules containing endpoint definitions for addresses, applications, and address groups within the pan_scm_sdk package. These modules include CRUD endpoint mappings to streamline API interactions for these entities.
Enhanced OAuth2Client with an extensive docstring explaining its purpose, attributes, errors, and return values. This improves code maintainability and clarity for future developers.
Introduce a new Mermaid file to visualize the class relationships within the SDK. The diagram includes various nodes representing classes and their methods, enhancing the documentation's comprehensibility.
Previously, the `id` field was a required attribute for the Address model. This change makes the `id` field optional, providing more flexibility for instances where an ID may not yet be assigned.
Enhanced README.md to include comprehensive usage examples for authentication, creating, listing, updating, and deleting address objects. Added detailed descriptions of key features such as OAuth2 authentication, resource management, data validation, and exception handling.
# Conflicts: # pan_scm_sdk/models/address.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Checklist for This Pull Request
🚨Please adhere to the guidelines for contributing to this repository.
Pull Request Description
Update README.md
What does this pull request accomplish?
Are there any breaking changes included?
Is there anything the reviewers should know?
Thank you for your contributions!