Skip to content

Api interfaces mark 1 #32135

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

Merged

Conversation

mrtuvn
Copy link
Contributor

@mrtuvn mrtuvn commented Feb 12, 2021

Description (*)

Marked following interfaces as API

lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php
lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php
lib/internal/Magento/Framework/Api/CriteriaInterface.php
lib/internal/Magento/Framework/Api/Search/AggregationInterface.php
lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php
lib/internal/Magento/Framework/Api/Search/BucketInterface.php
lib/internal/Magento/Framework/Api/Search/DocumentInterface.php
lib/internal/Magento/Framework/Api/Search/ReportingInterface.php
lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php
lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php
lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php
lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php
lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php
lib/internal/Magento/Framework/App/AreaInterface.php
lib/internal/Magento/Framework/App/Config/CommentInterface.php
lib/internal/Magento/Framework/App/Config/CommentParserInterface.php
lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php
lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php
lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php
lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php
lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php
lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php
lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php

References class/interfaces also marked api
lib/internal/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Mark Framework interfaces as API part 1 #32024

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

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 12, 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 12, 2021
@mrtuvn mrtuvn changed the base branch from 2.4-develop to 2.5-develop February 12, 2021 12:04
@gabrieldagama gabrieldagama added this to the 2.5 milestone Feb 18, 2021
@mrtuvn mrtuvn force-pushed the api-interfaces-mark-1 branch from 2ae4fb3 to cf3bebb Compare February 18, 2021 14:49
@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

@mrtuvn mrtuvn force-pushed the api-interfaces-mark-1 branch from cf3bebb to 1019b91 Compare February 20, 2021 07:35
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 20, 2021

Fixed static tests
@magento run all tests

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 20, 2021

@magento run WebAPI Tests, Functional Tests B2B

@hws47a hws47a self-requested a review February 20, 2021 16:54
@@ -7,6 +7,8 @@

/**
* Instances of this interface represent config binging items declared in etc/queue_topology.xsd
*
* @api
Copy link
Contributor

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 share why this class is also marked as @api?

Copy link
Contributor Author

@mrtuvn mrtuvn Feb 21, 2021

Choose a reason for hiding this comment

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

https://github.com/magento/magento2/blob/2.4-develop/lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php <= this class need marked api as purpose of this PR. When you see content this interface you can find this interface reference to another Magento\Framework\MessageQueue\Topology\Config\ExchangeConfigItem\BindingInterface (non-api)
So we also need mark this interface referenced to api too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You can see info interface listed in description

@magento-engcom-team
Copy link
Contributor

Hi @hws47a, thank you for the review.
ENGCOM-8802 has been created to process this Pull Request
✳️ @hws47a, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@hws47a hws47a added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Feb 21, 2021
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 3, 2021

Re-targeted PR branch to 2.4-develop as internal discussed with @gabrieldagama

@mrtuvn mrtuvn force-pushed the api-interfaces-mark-1 branch from 1019b91 to 61f8d7e Compare April 3, 2021 02:04
@mrtuvn mrtuvn changed the base branch from 2.5-develop to 2.4-develop April 3, 2021 02:05
@mrtuvn mrtuvn removed this from the 2.5 milestone Apr 3, 2021
@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 3, 2021

@magento run all tests

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Apr 3, 2021

@magento run WebAPI Tests

@gabrieldagama
Copy link
Contributor

@magento-engcom-team
Copy link
Contributor

@gabrieldagama the branch with code successfully imported intomagento-engcom/magento2ce repository. Branch name: imported-magento-magento2-32135.

@magento-cicd2 magento-cicd2 merged commit b4dc47a into magento:api-changes-develop Apr 13, 2021
@m2-assistant
Copy link

m2-assistant bot commented Apr 13, 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
Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Component: Amqp Component: Api Use with concrete module component label E.g. "Component: Api" + "Catalog" Component: App Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Progress: accept Project: API Changes QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mark Framework interfaces as API part 1
8 participants