Update schema handling and improve type safety #84
Conversation
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
Added support for PHP 8.4 in workflows and updated dependency versions for compatibility. Adjusted PHPUnit configuration for more robust error reporting and updated schema to PHPUnit 10.5. Corrected VSCode debug port and improved README formatting.
Updated method signatures and class properties across various files with strict type declarations. This enhances type safety and ensures better compatibility with modern PHP practices.
This update ensures methods explicitly indicate they override a parent class or interface method for better code clarity and consistency. Additionally, minor type adjustments and improvements to return type declarations were made to enhance code robustness.
Created a new document, `schema-classes.md`, detailing the features of `SwaggerSchema` and `OpenApiSchema`. Updated README and `contract-tests.md` to reference schema documentation and added guidance on using the `RestServer` component.
Expanded return type hints in test cases to accept both `SwaggerSchema` and `OpenApiSchema`. This ensures compatibility with both schema types and improves flexibility in schema handling across tests.
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
There was a problem hiding this comment.
I've completed my review and didn't find any issues... but I did find this rooster.
\\
(o>
\\_//)
\_/_)
_|_Files scanned
| File Path | Reviewed |
|---|---|
| src/Swagger/SwaggerResponseBody.php | ✅ |
| src/Exception/BaseException.php | ✅ |
| src/OpenApi/OpenApiResponseBody.php | ✅ |
| src/OpenApi/OpenApiRequestBody.php | ✅ |
| src/MockRequester.php | ✅ |
| src/ApiRequester.php | ✅ |
| src/Swagger/SwaggerRequestBody.php | ✅ |
| src/Swagger/SwaggerSchema.php | ✅ |
| src/OpenApi/OpenApiSchema.php | ✅ |
| src/Base/Schema.php | ✅ |
| src/AbstractRequester.php | ✅ |
| src/Base/Body.php | ✅ |
Explore our documentation to understand the languages and file types we support and the files we ignore.
Check out our docs on how you can make Korbit work best for you and your team.
Updated class names to better reflect their purpose by removing the "Test" suffix. This change applies to both the abstract base class and the specific test classes, aligning class naming with their actual roles.
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.
Changes Introduced
SwaggerSchemaandOpenApiSchema, enhancing flexibility in schema handling.schema-classes.mddetailing schema features. Updated README and existing documents with references and guidance forRestServerintegration.#[Override]attributes for methods overriding parent definitions. Made minor adjustments to types and return declarations.Checklist
Additional Notes
Ensure PHP 8.4 features are supported in all relevant project environments.
Description by Korbit AI
What change is being made?
Add support for PHP 8.4, improve type safety across the codebase, update composer dependencies, enhance PHPUnit configuration, and include documentation for schema handling, while refactoring code for better readability.
Why are these changes being made?
These changes are essential to accommodate the upcoming PHP 8.4 version, improve code maintainability and robustness through enhanced type safety and dependency updates, and provide clear documentation. Transitioning to more recent PHPUnit versions and refining configurations ensures better test coverage and more informative test outputs.