magento / magento2

Prior to making any Submission(s), you must sign an Adobe Contributor License Agreement, available here at: https://opensource.adobe.com/cla.html. All Submissions you make to Adobe Inc. and its affiliates, assigns and subsidiaries (collectively “Adobe”) are subject to the terms of the Adobe Contributor License Agreement.
http://www.magento.com
Open Software License 3.0
11.48k stars 9.29k forks source link

OpenAPI Swagger generation wrong error-parameters-item #37751

Open wouter-toppy opened 1 year ago

wouter-toppy commented 1 year ago

Preconditions and environment

Steps to reproduce

  1. Go to your api docs url: /rest/all/schema/?services\=all
  2. You find an item named error-parameters-item with the property fieldValue
  3. According to framework/Exception/InputException.php the property is value not fieldValue

Expected result

Api generator should change the fieldValue property to value.

So a generated API with OpenAPI Generator can successfully serialize the API output

Actual result

The API docs said the property is fieldValue but the actual API response is value. So Generated API clients cannot Serialize the output

Additional information

image image

Release note

No response

Triage and priority

m2-assistant[bot] commented 1 year ago

Hi @wouter-toppy. Thank you for your report. To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

yogesh-valiya-encora commented 1 year ago

@magento give me 2.4-develop instance

magento-deployment-service[bot] commented 1 year ago

Hi @yogesh-valiya-encora. Thank you for your request. I'm working on Magento instance for you.

magento-deployment-service[bot] commented 1 year ago

Hi @yogesh-valiya-encora, here is your Magento Instance: https://8c3ceb2a5a5beeed3674b964053d70f3.instances-prod.magento-community.engineering Admin access: https://8c3ceb2a5a5beeed3674b964053d70f3.instances-prod.magento-community.engineering/admin_43bb Login: 272cb566 Password: 7d4e8e8cd29f

m2-assistant[bot] commented 5 months ago

Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

engcom-November commented 5 months ago

Hello @wouter-toppy,

Thank you for the report and collaboration!

Verified this on 2.4-develop. In framework/Exception/InputException.php the parameter is value, but in /rest/all/schema/?services\=all url it's fieldValue. Hence confirming this issue.

Thank you.

github-jira-sync-bot commented 5 months ago

:white_check_mark: Jira issue https://jira.corp.adobe.com/browse/AC-11726 is successfully created for this GitHub issue.

m2-assistant[bot] commented 5 months ago

:white_check_mark: Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.