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

Adjust the Doc Blocks for the REST API #16

Merged
merged 3 commits into from
Oct 2, 2023

Conversation

avstudnitz
Copy link
Contributor

The Magento REST API needs a fully qualified class name in the doc blocks as these are parsed automatically.
With this change, tools like Swagger won't throw an error any more.

@avstudnitz avstudnitz requested review from a team as code owners September 29, 2023 08:58
gowrizrh
gowrizrh previously approved these changes Sep 29, 2023
Copy link
Member

@gowrizrh gowrizrh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right. i believe this was there before but removed after 2.4.4 introduced support to use the docblocks without FQN. but i'm happy to have it

@avstudnitz
Copy link
Contributor Author

@gowrizrh Thanks! I had issues with that in Magento 2.4.6, Swagger wouldn't start without the change.

@avstudnitz avstudnitz closed this Oct 2, 2023
@avstudnitz avstudnitz reopened this Oct 2, 2023
@avstudnitz avstudnitz merged commit 7869b14 into 3.x Oct 2, 2023
4 checks passed
@mage-os-ci mage-os-ci deleted the fix-rest-api-definition-for-swagger-2 branch March 18, 2024 20:19
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