Skip to content
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

32019 - Mark interfaces as api #32171

Closed
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 @@ -11,6 +11,7 @@

/**
* Interface used to return Asset id by content field.
* @api
*/
interface GetAssetIdsByContentFieldInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

/**
* Update the media assets to content relations. Assign new media assets and unassign media assets no longer used
* @api
*/
interface UpdateContentAssetLinksInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
* Interface used to return Asset id by content field.
* @api
*/
interface GetAssetIdsByContentFieldInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* Interface for Media content Config.
* @api
*/
interface SearchPatternConfigInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

/**
* Synchronize bulk assets and contents
* @api
*/
interface SynchronizeIdentitiesInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* Synchronize assets and contents
* @api
*/
interface SynchronizeInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* Get entities for media content by provided configuration.
* @api
*/
interface GetEntitiesInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

/**
* Search media gallery assets by search criteria
* @api
*/
interface SearchAssetsInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

/**
* Returns list of excluded regexp patterns
* @api
*/
interface ExcludedPatternsConfigInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

/**
* Add metadata to asset file
* @api
*/
interface AddMetadataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

/**
* Media asset metadata data transfer object
* @api
*/
interface MetadataInterface extends ExtensibleDataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
* Extract asset metadata
* @api
*/
interface ExtractMetadataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
* File internal data transfer object
* @api
*/
interface FileInterface extends ExtensibleDataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* File reader
* @api
*/
interface ReadFileInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

/**
* Metadata reader
* @api
*/
interface ReadMetadataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
* Segment internal data transfer object
* @api
*/
interface SegmentInterface extends ExtensibleDataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
* File writer
* @api
*/
interface WriteFileInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

/**
* Metadata writer
* @api
*/
interface WriteMetadataInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

/**
* Generate optimized version of media assets based on configuration for insertion to content
* @api
*/
interface GenerateRenditionsInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

/**
* Based on media assset path provides path to an optimized image version for insertion to the content
* @api
*/
interface GetRenditionPathInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

/**
* Synchronize assets from the provided files information to database
* @api
*/
interface SynchronizeFilesInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* Synchronize assets from the media storage to database
* @api
*/
interface SynchronizeInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
* Create media asset object from the media file
* @api
*/
interface CreateAssetFromFileInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

/**
* Fetch data from database in batches
* @api
*/
interface FetchBatchesInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

/**
* Save media files data
* @api
*/
interface ImportFilesInterface
{
Expand Down
1 change: 1 addition & 0 deletions app/code/Magento/MediaGalleryUiApi/Api/ConfigInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

/**
* Class responsible to provide API access to system configuration related to the Media Gallery
* @api
*/
interface ConfigInterface
{
Expand Down