Skip to content

Mark Various Modules interfaces as API #32152

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

/**
* Validate search engine configuration
*
* @api
*/
interface ValidatorInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Search/Setup/InstallConfigInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Configure search engine from installation input
*
* @api
*/
interface InstallConfigInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Security\Api\Data;
Expand All @@ -12,6 +11,8 @@

/**
* Interface UserExpirationInterface to be used as a DTO for expires_at property on User model.
*
* @api
*/
interface UserExpirationInterface extends \Magento\Framework\Api\ExtensibleDataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interface GenericInterface
*
* @api
*/
interface GenericInterface extends OptionSourceInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* The processor for store manipulations.
*
* @api
*/
interface ProcessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Interface \Magento\Store\Model\StoreResolver\ReaderInterface
*
* @api
*/
interface ReaderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
* Store switcher context interface
*
* @api
*/
interface ContextInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Store switcher redirect data interface
*
* @api
*/
interface RedirectDataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Store switcher redirect data post-processor interface
*
* @api
*/
interface RedirectDataPostprocessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Store switcher redirect data pre-processor interface
*
* @api
*/
interface RedirectDataPreprocessorInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Store switcher redirect data serializer interface
*
* @api
*/
interface RedirectDataSerializerInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Store/Model/StoreSwitcherInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Handles store switching procedure and detects url for final redirect after store switching.
*
* @api
*/
interface StoreSwitcherInterface
{
Expand Down
3 changes: 2 additions & 1 deletion app/code/Magento/Tax/Api/TaxAddressManagerInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\Tax\Api;

use Magento\Customer\Model\Address;

/**
* Interface to save data in customer session.
*
* @api
*/
interface TaxAddressManagerInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Notification interface for tax-related configuration issues.
*
* @api
*/
interface NotificationInterface extends \Magento\Framework\Notification\MessageInterface
{
Expand Down
5 changes: 1 addition & 4 deletions app/code/Magento/Tax/Model/TaxClass/Type/TypeInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,12 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

/**
* Interface for tax classes
*/
namespace Magento\Tax\Model\TaxClass\Type;

/**
* Interface \Magento\Tax\Model\TaxClass\Type\TypeInterface
*
* @api
*/
interface TypeInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Interface \Magento\Theme\Model\Design\Config\MetadataProviderInterface
*
* @api
*/
interface MetadataProviderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
* Store associated themes resolver.
*
* @api
*/
interface StoreThemesResolverInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interface DataTypeInterface
*
* @api
*/
interface DataTypeInterface extends UiComponentInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/Component/Layout/Tabs/TabInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface TabInterface
*
* @api
*/
interface TabInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/Component/Wysiwyg/ConfigInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface ConfigInterface
*
* @api
*/
interface ConfigInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/Config/Argument/ParserInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Convert node to array
*
* @api
*/
interface ParserInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/Config/ConverterInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Converter interface is used to convert UI Component XML configuration into UI Component interfaces arguments
*
* @api
*/
interface ConverterInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/Controller/UiActionInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface UiActionInterface
*
* @api
*/
interface UiActionInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* AddFieldToCollection interface
*
* @api
*/
interface AddFieldToCollectionInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* AddFilterToCollection interface
*
* @api
*/
interface AddFilterToCollectionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/DataProvider/Mapper/MapperInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface MapperInterface
*
* @api
*/
interface MapperInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Interface \Magento\Ui\DataProvider\Modifier\PoolInterface
*
* @api
*/
interface PoolInterface
{
Expand Down
4 changes: 3 additions & 1 deletion app/code/Magento/Ui/Model/ColorPicker/ModeInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Mode interface for color modes
*
* @api
*/
interface ModeInterface
{
Expand All @@ -18,5 +20,5 @@ interface ModeInterface
*
* @return array
*/
public function getConfig() : array ;
public function getConfig(): array ;
}
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/Model/UrlInput/ConfigInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Config interface for url link types
*
* @api
*/
interface ConfigInterface
{
Expand Down