Skip to content

Mark various interfaces as api #32157

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
Merged
merged 1 commit into from
Jun 1, 2021
Merged

Mark various interfaces as api #32157

merged 1 commit into from
Jun 1, 2021

Conversation

mrtuvn
Copy link
Contributor

@mrtuvn mrtuvn commented Feb 14, 2021 •
edited
Loading

Description (*)

The following interfaces marked as API

app/code/Magento/Msrp/Pricing/MsrpPriceCalculatorInterface.php
app/code/Magento/Newsletter/Model/SubscriptionManagerInterface.php
app/code/Magento/PageCache/Model/Spi/PageCacheTagsPreprocessorInterface.php
app/code/Magento/Payment/Api/Data/PaymentAdditionalInfoInterface.php

app/code/Magento/Payment/Model/Method/Online/GatewayInterface.php (non-api) because it referenced to deprecated argument interface
Magento\Payment\Model\Method\ConfigInterface. We should replace this with stable api such as Magento\Payment\Gateway\ConfigInterface

app/code/Magento/Payment/Model/Method/TransparentInterface.php
app/code/Magento/Paypal/Helper/Shortcut/ValidatorInterface.php
app/code/Magento/Paypal/Model/Billing/Agreement/MethodInterface.php
app/code/Magento/Paypal/Model/IpnInterface.php
app/code/Magento/Paypal/Model/Payflow/Service/Response/Handler/HandlerInterface.php

app/code/Magento/Paypal/Model/Payflow/Service/Response/ValidatorInterface.php (non-api) references following non-public types:
Magento\Paypal\Model\Payflow\Transparent

app/code/Magento/Quote/Api/ChangeQuoteControlInterface.php
app/code/Magento/Quote/Model/Cart/BuyRequest/BuyRequestDataProviderInterface.php
app/code/Magento/Quote/Model/Product/QuoteItemsCleanerInterface.php
app/code/Magento/Quote/Model/Quote/Address/CustomAttributeListInterface.php
app/code/Magento/Quote/Model/Quote/Address/Total/CollectorInterface.php
app/code/Magento/Quote/Model/Quote/Address/Total/ReaderInterface.php
app/code/Magento/Quote/Model/Quote/Item/CartItemProcessorInterface.php
app/code/Magento/Quote/Model/ValidationRules/QuoteValidationRuleInterface.php
app/code/Magento/QuoteGraphQl/Model/Cart/BuyRequest/BuyRequestDataProviderInterface.php
app/code/Magento/QuoteGraphQl/Model/Cart/Payment/AdditionalDataProviderInterface.php
app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingAddressesOnCartInterface.php
app/code/Magento/QuoteGraphQl/Model/Cart/SetShippingMethodsOnCartInterface.php
app/code/Magento/QuoteGraphQl/Model/CartItem/DataProvider/CustomizableOptionValueInterface.php
app/code/Magento/QuoteGraphQl/Model/CartItem/DataProvider/Processor/ItemDataProcessorInterface.php

Marked also references class/interface as api

app/code/Magento/Paypal/Model/Billing/AbstractAgreement.php

app/code/Magento/Quote/Model/Cart/Data/CartItem.php
app/code/Magento/Quote/Model/Quote/Item/Option.php

app/code/Magento/GraphQl/Model/Query/ContextInterface.php

lib/internal/Magento/Framework/GraphQl/Query/Resolver/ContextInterface.php
lib/internal/Magento/Framework/GraphQl/Exception/GraphQlNoSuchEntityException.php
lib/internal/Magento/Framework/GraphQl/Exception/GraphQlInputException.php
lib/internal/Magento/Framework/GraphQl/Exception/GraphQlAuthorizationException.php
lib/internal/Magento/Framework/GraphQl/Exception/GraphQlAuthenticationException.php

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Mark Msrp, Newsletter, PageCache, Payment, Paypal and Quote interfaces as API #32020

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

CC: @sivaschenko can you check valid mark api for app/code/Magento/Payment/Model/Method/Online/GatewayInterface.php
See more details above in PR description section

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 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

@m2-community-project m2-community-project bot added Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Progress: pending review labels Feb 14, 2021
@BarnyShergold BarnyShergold self-requested a review February 15, 2021 15:24
@BarnyShergold
Copy link

@magento run all tests

@BarnyShergold BarnyShergold self-assigned this Feb 15, 2021
@BarnyShergold
Copy link

@magento run Functional Tests B2B

@BarnyShergold
Copy link

@magento run Static Tests

@BarnyShergold
Copy link

@magento run Database Compare

@BarnyShergold
Copy link

@magento run Static Tests

@BarnyShergold
Copy link

@magento run Database Compare

BarnyShergold
BarnyShergold requested changes Feb 17, 2021
View reviewed changes
Copy link

@BarnyShergold BarnyShergold left a comment

Choose a reason for hiding this comment

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

The Database Compare & Static Tests keep failing but I can't see why what you've added would cause these issues. Can you check?

@engcom-Hotel engcom-Hotel self-assigned this Feb 18, 2021
@engcom-Hotel
Copy link
Contributor

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests EE

@engcom-Hotel
Copy link
Contributor

@magento run all tests

@gabrieldagama gabrieldagama added this to the 2.5 milestone Feb 18, 2021
@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B

2 similar comments
@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B

@mrtuvn
Copy link
Contributor Author

mrtuvn commented Feb 22, 2021

@magento run Functional Tests B2B

1 similar comment
@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B

@engcom-Hotel engcom-Hotel removed their assignment Feb 26, 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
Mark various interfaces as api
9d5819a 
update


update


update


update


update


update


up
@mrtuvn mrtuvn force-pushed the mark-various-interfaces-as-api-32020 branch from f43f9e2 to 9d5819a Compare April 3, 2021 02:11
@mrtuvn mrtuvn changed the base branch from 2.5-develop to 2.4-develop April 3, 2021 02:11
@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 Integration Tests, Functional Tests CE, Functional Tests EE

@gabrieldagama gabrieldagama changed the base branch from 2.4-develop to api-changes-develop May 6, 2021 12:48
@gabrieldagama
Copy link
Contributor

@magento import code to https://github.com/magento-engcom/magento2ce

@magento-engcom-team
Copy link
Contributor

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

@magento-cicd2 magento-cicd2 merged commit 456d4e9 into magento:api-changes-develop Jun 1, 2021
@m2-assistant
Copy link

m2-assistant bot commented Jun 1, 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

@gabrieldagama gabrieldagama gabrieldagama approved these changes

@BarnyShergold BarnyShergold Awaiting requested review from BarnyShergold

Assignees

@BarnyShergold BarnyShergold

@gabrieldagama gabrieldagama

Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Component: GraphQL GraphQL Component: Msrp Component: Newsletter Component: PageCache Component: Payment Component: Paypal Component: Quote Component: QuoteGraphQl Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Progress: accept Project: API Changes Release Line: 2.4
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Mark Msrp, Newsletter, PageCache, Payment, Paypal and Quote interfaces as API
6 participants
@mrtuvn @BarnyShergold @engcom-Hotel @magento-engcom-team @gabrieldagama @magento-cicd2