Skip to content

Mark api blocks customer store cms user directory #32087

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
Closed
wants to merge 1 commit into from
Closed

Mark api blocks customer store cms user directory #32087

wants to merge 1 commit into from

Conversation

mrtuvn
Copy link
Contributor

@mrtuvn mrtuvn commented Feb 10, 2021 •
edited
Loading

Description (*)

Mark blocks in modules customer, cms, store, user, directory as API

marked api annotation will keep remain as before only update following list in issue link below
All most class already marked api. We only need add strict_type

Magento\Customer\Block\SectionConfig
Magento\Customer\Block\CustomerData
Magento\Customer\Block\CustomerScopeData
Magento\Customer\Block\Newsletter
Magento\Customer\Block\Address\Grid (already marked api)
Magento\Customer\Block\Address\Book
Magento\Customer\Block\Address\Edit
Magento\Customer\Block\Form\Edit
Magento\Customer\Block\Form\Register
Magento\Customer\Block\Form\Login
Magento\Customer\Block\Form\Login\Info
Magento\Customer\Block\Account\SortLinkInterface
Magento\Customer\Block\Account\Resetpassword
Magento\Customer\Block\Account\Delimiter
Magento\Customer\Block\Account\Customer
Magento\Customer\Block\Account\Dashboard
Magento\Customer\Block\Account\Link
Magento\Customer\Block\Account\AuthorizationLink
Magento\Customer\Block\Account\Forgotpassword
Magento\Customer\Block\Account\AuthenticationPopup
Magento\Customer\Block\Account\Dashboard\Address
Magento\Customer\Block\Account\Dashboard\Info
Magento\User\Block\Buttons
Magento\Directory\Block\Currency
Magento\Store\Block\Switcher
Magento\Cms\Block\Page
Magento\Cms\Block\Adminhtml\Wysiwyg\Images\Content (already marked api)
Magento\Cms\Block\Adminhtml\Wysiwyg\Images\Tree
Magento\Cms\Block\Adminhtml\Wysiwyg\Images\Content\Files

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Mark Customer, User, Directory, Store and Cms Blocks as API #32048

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

CC @sivaschenko re-check @api mark and cleanup

Contribution checklist (*)

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

@m2-assistant
Copy link

m2-assistant bot commented Feb 10, 2021

Hi @mrtuvn. Thank you for your contribution
Here are 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

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

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

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@m2-community-project m2-community-project bot added the Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. label Feb 10, 2021
@mrtuvn mrtuvn changed the base branch from 2.4-develop to 2.5-develop February 10, 2021 12:43
@gabrieldagama gabrieldagama added this to the 2.5 milestone Feb 10, 2021
@ihor-sviziev ihor-sviziev self-assigned this Feb 10, 2021
@ihor-sviziev ihor-sviziev removed their assignment Feb 10, 2021
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 14, 2021

@magento run all tests

@mrtuvn mrtuvn closed this Feb 14, 2021
@m2-assistant
Copy link

m2-assistant bot commented Feb 14, 2021

Hi @mrtuvn, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@mrtuvn mrtuvn reopened this Feb 14, 2021
@m2-assistant
Copy link

m2-assistant bot commented Feb 14, 2021

Hi @mrtuvn. Thank you for your contribution
Here are 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.5-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

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

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@mrtuvn mrtuvn force-pushed the api-blocks-customer-store-cms-user-directory branch from 7acdabc to 38df5dd Compare February 18, 2021 14:51
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 18, 2021

Rebased 2.5-develop

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 19, 2021

@magento run all tests

eduard13
eduard13 requested changes Feb 26, 2021
View reviewed changes
Copy link
Contributor

@eduard13 eduard13 left a comment

Choose a reason for hiding this comment

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

Hi @mrtuvn could you please remove the @author annotation from the following classes?

  • Magento\Customer\Block\Address\Book
  • Magento\Customer\Block\Form\Login

Thank you.

@mrtuvn
Mark blocks customer, store, cms as API
e020ab7 
update


update


update


update 


update
@mrtuvn mrtuvn force-pushed the api-blocks-customer-store-cms-user-directory branch from a3ab484 to e020ab7 Compare April 13, 2021 15:54
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 22, 2021

@magento run Integration Tests

3 similar comments
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 24, 2021

@magento run Integration Tests

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 26, 2021

@magento run Integration Tests

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 29, 2021

@magento run Integration Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 29, 2021

@magento run Integration Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@mrtuvn
Copy link
Contributor Author

mrtuvn commented May 12, 2021

@magento run Integration Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@mrtuvn
Copy link
Contributor Author

mrtuvn commented May 28, 2021

@magento run Integration Tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@mrtuvn
Copy link
Contributor Author

mrtuvn commented May 28, 2021 •
edited
Loading

@gabrieldagama can i close this now ? Since not much change here only some small additional (strict_type)

@mrtuvn
Copy link
Contributor Author

mrtuvn commented May 28, 2021

#32048 (comment)
closed this by this comment

@mrtuvn mrtuvn closed this May 28, 2021
@m2-assistant
Copy link

m2-assistant bot commented May 28, 2021

Hi @mrtuvn, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

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

@eduard13 eduard13 eduard13 approved these changes

Assignees

@eduard13 eduard13

@engcom-Foxtrot engcom-Foxtrot

Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Component: Authorization Component: AwsS Component: Backend Component: Bundle Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Project: API Changes QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4
Projects
None yet
Milestone
2.5
Development

Successfully merging this pull request may close these issues.

Mark Customer, User, Directory, Store and Cms Blocks as API
7 participants
@mrtuvn @eduard13 @magento-engcom-team @engcom-Oscar @gabrieldagama @ihor-sviziev @engcom-Foxtrot