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

OA annotation to php8 + some namespace fixes #610

Merged
merged 5 commits into from
Feb 21, 2024

Conversation

nkondrashov
Copy link
Contributor

Q A
Is bugfix? ✔️ & ❌
New feature? ✔️
Breaks BC? ❌?
Fixed issues Part of yiisoft/yii-swagger#84

Copy link

what-the-diff bot commented Feb 20, 2024

PR Summary

  • Updating OpenAPI Annotations
    Throughout various files, the OpenAPI annotations have been updated from @OA to #[OA\ ... ]. This simply represents an upgrade in the way we make OpenAPI annotations which could improve code readability and maintainability.

  • Dependency Version Update in composer.json
    The yiisoft/hydrator-validator dependency has been upgraded from dev-master to ^1.0 which means our project is now relying on a stable version of hydrator-validator, eliminating potential risks associated with using a development version.

  • Namespace Updates
    The class namespaces for PhpFileSchemaProvider and SynchronousAdapter have been updated in common/params.php. This could be the result of a restructure in the project directories or upgrading the related packages.

  • Method Name Update
    The method name handle has been updated to process for the SwaggerJson action in common/routes.php, indicating a potential clarification or expansion of this method's responsibilities.

  • New Attributes in ApiResponseData
    New properties such as status, errorMessage, and errorCode have been added to the ApiResponseData class in Dto/ApiResponseData.php. This suggests an enhancement in the responses of our API, providing more detailed responses and potentially better error handling.

  • Import and Annotation Changes
    Many changes have involved replacing older OpenApi\Annotations imports with the updated OpenApi\Attributes. This keeps our codebase up-to-date with the latest standards in OpenAPI usage.

  • QueueFactoryInterface Import Change
    In UserService.php, the Yiisoft\Yii\Queue\QueueFactoryInterface has been replaced with Yiisoft\Queue\QueueFactoryInterface, representing an update in the way we handle queue factory interfaces in our project.

  • Swagger Middleware Annotation Path Update
    In params.php, the 'yiisoft/yii-swagger' configuration has been updated to include @src/Middleware in the annotation-paths parameter, suggesting an expansion in the usage of Swagger for documenting middlewares.

  • Action Name Update
    In routes.php, the action 'handle' of the SwaggerJson class has been updated to 'process' which supports better description of the action's role.

blog-api/README.md Outdated Show resolved Hide resolved
@samdark samdark merged commit bdcf491 into yiisoft:master Feb 21, 2024
6 of 14 checks passed
@samdark
Copy link
Member

samdark commented Feb 21, 2024

Thanks!

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