Class PublishController
- java.lang.Object
-
- org.craftercms.studio.controller.rest.v2.PublishController
-
@Validated @RestController @RequestMapping("/api/2/publish") public class PublishController extends Object
-
-
Constructor Summary
Constructors Constructor Description PublishController(PublishService publishService, SitesService sitesService)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ResponseBody
cancelPublishingPackages(@Valid CancelPublishingPackagesRequest cancelPublishingPackagesRequest)
ResponseBody
clearPublishingLock(@Valid ClearPublishingLockRequest clearPublishingLockRequest)
ResponseBody
getAvailablePublishingTargets(String siteId)
ResultList<DeploymentHistoryGroup>
getPublishingHistory(String siteId, @javax.validation.constraints.PositiveOrZero int daysFromToday, @javax.validation.constraints.PositiveOrZero int numberOfItems, String filterType)
ResponseBody
getPublishingPackageDetails(String siteId, UUID packageId)
PaginatedResultList<PublishingPackage>
getPublishingPackages(String siteId, String environment, String path, List<String> states, @javax.validation.constraints.PositiveOrZero int offset, @javax.validation.constraints.PositiveOrZero int limit)
ResponseBody
getPublishingStatus(String siteId)
@Valid ResponseBody
hasInitialPublish(String siteId)
Result
publishAll(@Valid PublishAllRequest request)
-
-
-
Constructor Detail
-
PublishController
@ConstructorProperties({"publishService","sitesService"}) public PublishController(PublishService publishService, SitesService sitesService)
-
-
Method Detail
-
getPublishingPackages
@GetMapping("/packages") public PaginatedResultList<PublishingPackage> getPublishingPackages(@RequestParam(name="siteId") String siteId, @RequestParam(name="environment",required=false) String environment, @RequestParam(name="path",required=false) String path, @RequestParam(name="states",required=false) List<String> states, @RequestParam(name="offset",required=false,defaultValue="0") @PositiveOrZero @javax.validation.constraints.PositiveOrZero int offset, @RequestParam(name="limit",required=false,defaultValue="10") @PositiveOrZero @javax.validation.constraints.PositiveOrZero int limit) throws SiteNotFoundException
- Throws:
SiteNotFoundException
-
getPublishingPackageDetails
@GetMapping("/package") public ResponseBody getPublishingPackageDetails(@RequestParam(name="siteId") String siteId, @RequestParam(name="packageId") UUID packageId) throws SiteNotFoundException, PublishingPackageNotFoundException
-
cancelPublishingPackages
@PostMapping("/cancel") public ResponseBody cancelPublishingPackages(@Valid @RequestBody @Valid CancelPublishingPackagesRequest cancelPublishingPackagesRequest) throws ServiceLayerException, UserNotFoundException
-
getPublishingStatus
@GetMapping("/status") public ResponseBody getPublishingStatus(@RequestParam(name="siteId") String siteId) throws SiteNotFoundException
- Throws:
SiteNotFoundException
-
clearPublishingLock
@PostMapping(value="/clear_lock", consumes="application/json") public ResponseBody clearPublishingLock(@Valid @RequestBody @Valid ClearPublishingLockRequest clearPublishingLockRequest) throws SiteNotFoundException
- Throws:
SiteNotFoundException
-
getPublishingHistory
@GetMapping(value="/history", produces="application/json") public ResultList<DeploymentHistoryGroup> getPublishingHistory(@RequestParam(name="siteId") String siteId, @PositiveOrZero @RequestParam(name="days") @javax.validation.constraints.PositiveOrZero int daysFromToday, @PositiveOrZero @RequestParam(name="num") @javax.validation.constraints.PositiveOrZero int numberOfItems, @RequestParam(name="filterType",required=false,defaultValue="page") String filterType) throws SiteNotFoundException
- Throws:
SiteNotFoundException
-
getAvailablePublishingTargets
@GetMapping(value="/available_targets", produces="application/json") public ResponseBody getAvailablePublishingTargets(@RequestParam(name="siteId") String siteId) throws SiteNotFoundException
- Throws:
SiteNotFoundException
-
hasInitialPublish
@Valid @GetMapping(value="/has_initial_publish", produces="application/json") public @Valid ResponseBody hasInitialPublish(@RequestParam(name="siteId") String siteId) throws SiteNotFoundException
- Throws:
SiteNotFoundException
-
publishAll
@PostMapping("/all") public Result publishAll(@Valid @RequestBody @Valid PublishAllRequest request) throws ServiceLayerException, UserNotFoundException
-
-