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.

Sign up for GitHub

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

Jump to bottom

Added optional description field to the <route> tag in webapi.xml #27868

Open
wants to merge 14 commits into
base: 2.5-develop
Choose a base branch
from
Open

Added optional description field to the <route> tag in webapi.xml #27868

wants to merge 14 commits into from

Conversation

o-blinnikov
Copy link

@o-blinnikov o-blinnikov commented Apr 15, 2020 •
edited
Loading

Description (*)

Currently information on every bulk request is stored in database (magento_bulk table) and has a description field. This description filed is currently autogenerated as "Topic %". Where % - is a queue topic name that used.
Tehnically everything works correctly, but those descriptions are used for display messages for end user in Magento Backend. And this leading to confusion that usually Backend users has no idea what does that mean, especially if Bulk API used, where topic names are auto-generated.

This PR is adding an optional attribute to webapi.xml schema, where users can define API request description. This will allow to use this description for Async/Bulk requests descriptions which will improve user experince.

Related Pull Requests

Fixed Issues (if relevant)

  1. magento/magento2#<issue_number>: Issue title

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

Contribution checklist (*)

  • All commits are accompanied by meaningful commit messages
  • Pull request has a meaningful description of its purpose
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Added optional description field to the <route> tag in webapi.xml #29592: Added optional description field to the tag in webapi.xml

@o-blinnikov o-blinnikov requested a review from nuzil April 15, 2020 16:20
@m2-assistant
Copy link

m2-assistant bot commented Apr 15, 2020

Hi @o-blinnikov. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

@magento-engcom-team magento-engcom-team added Component: AsynchronousOperations Component: Webapi Use with concrete module component label E.g. "Component: Webapi" + "Catalog" Component: WebapiAsync Release Line: 2.4 Partner: Comwrap partners-contribution Pull Request is created by Magento Partner labels Apr 15, 2020
@nuzil nuzil self-assigned this Apr 15, 2020
@nuzil
Copy link
Contributor

nuzil commented Apr 22, 2020

As Note, looks like tests failed by the reason we added new field to the schema, have to be fixed

@sidolov
Copy link
Contributor

sidolov commented Aug 17, 2020

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Aug 17, 2020
Open
4 tasks
@sidolov sidolov added Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Aug 17, 2020
o-blinnikov and others added 2 commits February 10, 2021 16:07
@o-blinnikov
Merge remote-tracking branch 'origin/2.4-develop' into async-operatio…
b0c9013 
…ns-description

# Conflicts:
#	app/code/Magento/WebapiAsync/Test/Unit/Model/ConfigTest.php
#	dev/tests/integration/testsuite/Magento/AsynchronousOperations/Model/MassScheduleTest.php
@o-blinnikov
Merge branch '2.4-develop' into async-operations-description
88d41d3
@nuzil
Copy link
Contributor

nuzil commented Feb 11, 2021

@magento run all tests

@o-blinnikov o-blinnikov changed the base branch from 2.4-develop to 2.5-develop March 16, 2021 08:57
@nuzil
Copy link
Contributor

nuzil commented Mar 18, 2021

@magento run all tests

@nuzil
Copy link
Contributor

nuzil commented Mar 19, 2021

@magento run all tests

@nuzil
Copy link
Contributor

nuzil commented Mar 19, 2021

@magento run all tests

@nuzil
Copy link
Contributor

nuzil commented Mar 19, 2021

@magento run all tests

@nuzil nuzil added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: test coverage labels Mar 19, 2021
@nuzil
Copy link
Contributor

nuzil commented Mar 19, 2021

@magento run all tests

@nuzil
Copy link
Contributor

nuzil commented Mar 22, 2021

@magento run all tests

@nuzil
Copy link
Contributor

nuzil commented Mar 22, 2021

@magento run Functional Tests B2B

@magento-engcom-team
Copy link
Contributor

Hi @nuzil, thank you for the review.
ENGCOM-8960 has been created to process this Pull Request

@engcom-Delta engcom-Delta added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Apr 10, 2024
@engcom-Dash
Copy link
Contributor

Moving this PR to on hold since we are not picking up any PRs against the 2.5-develop branch right now. Once we pick it up, we will move it to the appropriate status.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nuzil nuzil nuzil approved these changes

Assignees

@nuzil nuzil

Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Award: test coverage Component: AsynchronousOperations Component: Webapi Use with concrete module component label E.g. "Component: Webapi" + "Catalog" Component: WebapiAsync Partner: Comwrap partners-contribution Pull Request is created by Magento Partner Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Progress: ready for testing Release Line: 2.5 Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Pull Requests Dashboard
Status: On Hold
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] Added optional description field to the <route> tag in webapi.xml
6 participants
@o-blinnikov @nuzil @sidolov @magento-engcom-team @engcom-Dash @engcom-Delta