Bulk api status #6
Conversation
…bulk api statuses
|
|
||
| /** | ||
| * @api | ||
| * @since 100.3.0 |
There was a problem hiding this comment.
No need to put @since annotation, it will be added automatically by release publication tools.
| * @api | ||
| * @since 100.3.0 | ||
| */ | ||
| interface BulkRepositoryInterface |
There was a problem hiding this comment.
Does not look like repository, which usually has CRUD operations. How about BlulkStatusInterface? Then methods could be named getStatus and getDetailedStatus.
| * @api | ||
| * @since 100.3.0 | ||
| */ | ||
| interface ShortInterface extends BulkSummaryInterface |
There was a problem hiding this comment.
Interfaces could be renamed to Api/Data/BulkStatusInterface and Api/Data/DetailedBulkStatusInterface
| * @return \Magento\AsynchronousOperations\Api\Data\OperationDetailsInterface|null | ||
| * @since 100.3.0 | ||
| */ | ||
| public function getOperationsCounter(); |
There was a problem hiding this comment.
Not clear why counter type is OperationDetailedInterface
| use Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface; | ||
|
|
||
| /** | ||
| * Interface BulkStatusInterface |
There was a problem hiding this comment.
Please add proper description for all classes/interfaces, especially @api ones.
| * @return int | ||
| * @since 100.3.0 | ||
| */ | ||
| public function getOperationsTotal(); |
| public function getOperationsTotal(); | ||
|
|
||
| /** | ||
| * Open operations count |
| * @return int | ||
| * @since 100.3.0 | ||
| */ | ||
| public function getOperationsSuccessful(); |
| * @return int | ||
| * @since 100.3.0 | ||
| */ | ||
| public function getTotalFailed(); |
There was a problem hiding this comment.
getFailedCount? And same pattern for the rest of the operations in the interface.
| /** | ||
| * Upgrade the AsynchronousOperations module DB scheme | ||
| */ | ||
| class UpgradeSchema implements UpgradeSchemaInterface |
There was a problem hiding this comment.
New modules should have InstallSchema, not UpgradeSchema
…interfaces and methods
[Forwardport] Fixed syntax for before-after operators in less files.
[Forwardport] Translated validation error messages
2.3-develop branch upadate
Update 2.3-develop branch
Current Pull Request will add Status API functionality for module AsynchronousOperations.
After creating Bulk operation, Magento creates new UUID for this operation. To be able to track status of each operation was developer API.
REST api call example:
GET /V1/bulk/status-detailed/:UUID
Response will look like this:
{ "operations_list": [ { "id": 0, "topic_name": "string", "status": 0, "result_serialized_data": "string", "result_message": "string", "error_code": 0 } ], "operations_counter": { "operations_total": 0, "open": 0, "operations_successful": 0, "total_failed": 0, "failed_not_retriable": 0, "failed_retriable": 0, "rejected": 0 }, "extension_attributes": {}, "bulk_id": "string", "description": "string", "start_time": "string", "user_id": 0, "operation_count": 0 }REST api call example:
GET /V1/bulk/status-short/:UUID
Response will look like this.
Instead of get all operation entity data this resource give just operation status (e.g. without result_serialized_data, topic_name or extension_attributes):
{ "operations_list": [ { "id": 0, "status": 0, "result_message": "string", "error_code": 0 } ], "operations_counter": { "operations_total": 0, "open": 0, "operations_successful": 0, "total_failed": 0, "failed_not_retriable": 0, "failed_retriable": 0, "rejected": 0 }, "extension_attributes": {}, "bulk_id": "string", "description": "string", "start_time": "string", "user_id": 0, "operation_count": 0 }Contribution checklist