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.

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

Adjust the Doc Blocks for the REST API #16

Merged
merged 3 commits into from
Oct 2, 2023
Merged

Adjust the Doc Blocks for the REST API #16

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be63525
Adjust the Doc Blocks for the REST API so tools like Swagger don't th…
avstudnitz Sep 29, 2023
e1c4b86
Display the "status" column in the subscription grid as select instea…
avstudnitz Sep 29, 2023
d052a22
Revert "Display the "status" column in the subscription grid as selec…
avstudnitz Sep 29, 2023
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
8 changes: 4 additions & 4 deletions Api/AsyncEventRepositoryInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface AsyncEventRepositoryInterface
* Get a single asynchronous event by id
*
* @param int $subscriptionId
* @return AsyncEventDisplayInterface
* @return \MageOS\AsyncEvents\Api\Data\AsyncEventDisplayInterface
* @throws NoSuchEntityException
*/
public function get(int $subscriptionId): AsyncEventDisplayInterface;
Expand All @@ -28,16 +28,16 @@ public function get(int $subscriptionId): AsyncEventDisplayInterface;
* Get a list of asynchronous events by search criteria
*
* @param SearchCriteriaInterface $searchCriteria
* @return AsyncEventSearchResultsInterface
* @return \MageOS\AsyncEvents\Api\Data\AsyncEventSearchResultsInterface
*/
public function getList(SearchCriteriaInterface $searchCriteria): AsyncEventSearchResultsInterface;

/**
* Save an asynchronous event
*
* @param AsyncEventInterface $asyncEvent
* @param \MageOS\AsyncEvents\Api\Data\AsyncEventInterface $asyncEvent
* @param bool $checkResources
* @return AsyncEventDisplayInterface
* @return \MageOS\AsyncEvents\Api\Data\AsyncEventDisplayInterface
* @throws NoSuchEntityException
* @throws LocalizedException
* @throws AlreadyExistsException
Expand Down