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.

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

Merged
merged 1 commit into from
Apr 13, 2021
Merged

Api interfaces mark 1 #32135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Exchange binding installer.
*
* @api
*/
interface BindingInstallerInterface
{
Expand Down
3 changes: 2 additions & 1 deletion lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
namespace Magento\Framework\Api;

/**
* Interface \Magento\Framework\Api\AttributeTypeResolverInterface
* Interface Attribute Type Resolver
*
* @api
*/
interface AttributeTypeResolverInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Api/CriteriaInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface CriteriaInterface
*
* @api
*/
interface CriteriaInterface
{
Expand Down
4 changes: 3 additions & 1 deletion lib/internal/Magento/Framework/Api/Search/AggregationInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
namespace Magento\Framework\Api\Search;

/**
* Faceted data
* Interface Aggregation fo get faceted data
*
* @api
*/
interface AggregationInterface
{
Expand Down
3 changes: 2 additions & 1 deletion lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@
namespace Magento\Framework\Api\Search;

/**
* Interface \Magento\Framework\Api\Search\AggregationValueInterface
* Interface Aggregation Value
*
* @api
*/
interface AggregationValueInterface
{
Expand Down
4 changes: 3 additions & 1 deletion lib/internal/Magento/Framework/Api/Search/BucketInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
namespace Magento\Framework\Api\Search;

/**
* Facet Bucket
* Interface for facet Bucket
*
* @api
*/
interface BucketInterface
{
Expand Down
3 changes: 2 additions & 1 deletion lib/internal/Magento/Framework/Api/Search/DocumentInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
use Magento\Framework\Api\CustomAttributesDataInterface;

/**
* Interface \Magento\Framework\Api\Search\DocumentInterface
* Interface Search Document
*
* @api
*/
interface DocumentInterface extends CustomAttributesDataInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Api/Search/ReportingInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface ReportingInterface
*
* @api
*/
interface ReportingInterface
{
Expand Down
1 change: 1 addition & 0 deletions ...rk/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
* AND
* (CustomCondition_2 OR CustomCondition_3)
*
* @api
*/
interface CustomConditionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions ...earchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
*
* Used to store processors as mapping attributeName => CustomConditionInterface
* You can use di.xml to configure with any custom conditions you need
*
* @api
*/
interface CustomConditionProviderInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Base Builder interface for simple data Objects
*
* @api
*/
interface SimpleBuilderInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing CONNECT requests.
*
* @api
*/
interface HttpConnectActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing DELETE requests.
*
* @api
*/
interface HttpDeleteActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Marker for actions processing GET requests.
*
* @api
*/
interface HttpGetActionInterface extends HttpHeadActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing OPTIONS requests.
*
* @api
*/
interface HttpOptionsActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing PATCH requests.
*
* @api
*/
interface HttpPatchActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing POST requests.
*
* @api
*/
interface HttpPostActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing PROPFIND requests.
*
* @api
*/
interface HttpPropfindActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing PUT requests.
*
* @api
*/
interface HttpPutActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing TRACE requests.
*
* @api
*/
interface HttpTraceActionInterface extends ActionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/AreaInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Interface AreaInterface
*
* @api
*/
interface AreaInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Config/CommentInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interface CommentInterface
*
* @api
*/
interface CommentInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Config/CommentParserInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interface for parsing comments in the configuration file.
*
* @api
*/
interface CommentParserInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Resource for storing store configuration values
*
* @api
*/
interface ConfigInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interface ConfigSourceInterface
*
* @api
*/
interface ConfigSourceInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Interface ConfigTypeInterface
*
* @api
*/
interface ConfigTypeInterface
{
Expand Down
1 change: 1 addition & 0 deletions lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
* Provide access to data. Each Source can be responsible for each storage, where config data can be placed
*
* @package Magento\Framework\App\Config\Reader\Source
* @api
*/
interface SourceInterface
{
Expand Down
1 change: 1 addition & 0 deletions lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
/**
* Interface \Magento\Framework\App\Config\Scope\ReaderInterface
*
* @api
*/
interface ReaderInterface
{
Expand Down
1 change: 1 addition & 0 deletions lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* @see SourceInterface
* @see ConfigTypeInterface
* @package Magento\Framework\App\Config\Spi
* @api
*/
interface PostProcessorInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Allows to use custom callbacks and functions before applying fallback
*
* @api
*/
interface PreProcessorInterface
{
Expand Down
2 changes: 2 additions & 0 deletions ...al/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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

*/
interface BindingInterface
{
Expand Down