Skip to content

[32018][To 2.4-develop] Marked GraphQl, ImportExport, Indexer, Integration and LoginAsCustomer interfaces as API #32727

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
merged 3 commits into from
Apr 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Use this interface to implement a processor for each entry of a header in an HTTP GraphQL request.
*
* @api
*/
interface HttpHeaderProcessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Use this interface to implement a validator for a Graphql HTTP requests
*
* @api
*/
interface HttpRequestValidatorInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/GraphQl/Model/Query/ContextInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
*
* GraphQL will pass the same instance of this interface to each field resolver, so these resolvers could have
* shared access to the same data for ease of implementation purposes.
*
* @api
*/
interface ContextInterface extends BaseContextInterface, ExtensibleDataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Provide possibility to add custom parameters to context object
*
* @api
*/
interface ContextParametersInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
* - Class must extend ContextParametersProcessorInterface.
* - Implement execute method which adds additional data to the context though extension attributes.
* - This data will be present in each resolver.
*
* @api
*/
interface ContextParametersProcessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Extended export interface for implementation of Skipped Attributes which are missing from the basic interface
*
* @api
*/
interface ExtendedExportInfoInterface extends ExportInfoInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\ImportExport\Model\Report;

use Magento\ImportExport\Model\Import\ErrorProcessing\ProcessingErrorAggregatorInterface;

/**
* Error report generator interface
*
* @api
*/
interface ReportProcessorInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Indexer/Model/DimensionModes.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* DTO to work with dimension modes
*
* @api
*/
class DimensionModes
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Indexer/Model/ModeSwitcherInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interface to switch indexer mode
*
* @api
*/
interface ModeSwitcherInterface
{
Expand Down
3 changes: 3 additions & 0 deletions app/code/Magento/Indexer/Model/Source/DataInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Indexer\Model\Source;

use Magento\Framework\Exception\NotFoundException;

/**
* Interface \Magento\Indexer\Model\Source\DataInterface
*
* @api
*/
interface DataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Integration\Model\Oauth\Token\RequestLog;

/**
* OAuth token request log reader interface.
*
* @api
*/
interface ReaderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Integration\Model\Oauth\Token\RequestLog;

/**
* OAuth token request log writer interface.
*
* @api
*/
interface WriterInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* IsLoginAsCustomerEnabledForCustomerInterface results.
*
* @api
*/
interface IsLoginAsCustomerEnabledForCustomerResultInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Get id of Admin logged as Customer.
*
* @api
*/
interface GetLoggedAsCustomerAdminIdInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Get id of Customer Admin is logged as.
*
* @api
*/
interface GetLoggedAsCustomerCustomerIdInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
* Check if Login as Customer functionality is enabled for Customer.
*
* @api
*/
interface IsLoginAsCustomerEnabledForCustomerInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Set id of Admin logged as Customer.
*
* @api
*/
interface SetLoggedAsCustomerAdminIdInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Set id of Customer Admin is logged as.
*
* @api
*/
interface SetLoggedAsCustomerCustomerIdInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* LoginAsCustomerAssistance config.
*
* @api
*/
interface ConfigInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Get 'assistance_allowed' attribute from Customer.
*
* @api
*/
interface IsAssistanceEnabledInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Set 'assistance_allowed' attribute to Customer.
*
* @api
*/
interface SetAssistanceInterface
{
Expand Down
5 changes: 5 additions & 0 deletions lib/internal/Magento/Framework/App/HttpRequestInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@

namespace Magento\Framework\App;

/**
* Interface HttpRequestInterface
*
* @api
*/
interface HttpRequestInterface
{
/**
Expand Down