Fix docblocks
This commit is contained in:
@@ -26,7 +26,7 @@ class ComponentController extends AbstractApiController
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
*
|
||||
* @return \Illuminate\Database\Eloquent\Collection
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function getComponents(Request $request)
|
||||
{
|
||||
@@ -40,7 +40,7 @@ class ComponentController extends AbstractApiController
|
||||
*
|
||||
* @param \CachetHQ\Cachet\Models\Component $component
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Component
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function getComponent(Component $component)
|
||||
{
|
||||
@@ -52,7 +52,7 @@ class ComponentController extends AbstractApiController
|
||||
*
|
||||
* @param \Illuminate\Contracts\Auth\Guard $auth
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Component
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function postComponents(Guard $auth)
|
||||
{
|
||||
@@ -86,7 +86,7 @@ class ComponentController extends AbstractApiController
|
||||
*
|
||||
* @param \CachetHQ\Cachet\Models\Componet $component
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Component
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function putComponent(Component $component)
|
||||
{
|
||||
|
||||
@@ -13,6 +13,11 @@ namespace CachetHQ\Cachet\Http\Controllers\Api;
|
||||
|
||||
class GeneralController extends AbstractApiController
|
||||
{
|
||||
/**
|
||||
* Ping endpoint allows API consumers to check the version.
|
||||
*
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function ping()
|
||||
{
|
||||
return $this->item('Pong!');
|
||||
|
||||
@@ -27,7 +27,7 @@ class IncidentController extends AbstractApiController
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
* @param \Illuminate\Contracts\Auth\Guard $auth
|
||||
*
|
||||
* @return \Illuminate\Database\Eloquent\Collection
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function getIncidents(Request $request, Guard $auth)
|
||||
{
|
||||
@@ -43,7 +43,7 @@ class IncidentController extends AbstractApiController
|
||||
*
|
||||
* @param \CachetHQ\Cachet\Models\Incident $incident
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Incident
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function getIncident(Incident $incident)
|
||||
{
|
||||
@@ -55,7 +55,7 @@ class IncidentController extends AbstractApiController
|
||||
*
|
||||
* @param \Illuminate\Contracts\Auth\Guard $auth
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Incident
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function postIncidents(Guard $auth)
|
||||
{
|
||||
@@ -83,7 +83,7 @@ class IncidentController extends AbstractApiController
|
||||
*
|
||||
* @param \CachetHQ\Cachet\Models\Inicdent $incident
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Incident
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function putIncident(Incident $incident)
|
||||
{
|
||||
|
||||
@@ -38,7 +38,7 @@ class MetricController extends AbstractApiController
|
||||
*
|
||||
* @param \CachetHQ\Cachet\Models\Metric $metric
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Metric
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function getMetric(Metric $metric)
|
||||
{
|
||||
@@ -60,7 +60,7 @@ class MetricController extends AbstractApiController
|
||||
/**
|
||||
* Create a new metric.
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Metric
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function postMetrics()
|
||||
{
|
||||
@@ -78,7 +78,7 @@ class MetricController extends AbstractApiController
|
||||
*
|
||||
* @param \CachetHQ\Cachet\Models\Metric $metric
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Metric
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function putMetric(Metric $metric)
|
||||
{
|
||||
|
||||
@@ -25,7 +25,7 @@ class MetricPointController extends AbstractApiController
|
||||
* @param \CachetHQ\Cachet\Models\Metric $metric
|
||||
* @param \CachetHQ\Cachet\Models\MetricPoint $metricPoint
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\MetricPoint
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function getMetricPoints(Metric $metric, MetricPoint $metricPoint)
|
||||
{
|
||||
@@ -37,7 +37,7 @@ class MetricPointController extends AbstractApiController
|
||||
*
|
||||
* @param \CachetHQ\Cachet\Models\Metric $metric
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\MetricPoint
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function postMetricPoints(Metric $metric)
|
||||
{
|
||||
@@ -64,7 +64,7 @@ class MetricPointController extends AbstractApiController
|
||||
* @param \CachetHQ\Cachet\Models\Metric $metric
|
||||
* @param \CachetHQ\Cachet\Models\MetircPoint $metricPoint
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\MetricPoint
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function putMetricPoint(Metric $metric, MetricPoint $metricPoint)
|
||||
{
|
||||
@@ -87,7 +87,7 @@ class MetricPointController extends AbstractApiController
|
||||
* @param \CachetHQ\Cachet\Models\Metric $metric
|
||||
* @param \CachetHQ\Cachet\Models\MetricPoint $metricPoint
|
||||
*
|
||||
* @return \Dingo\Api\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function deleteMetricPoint(Metric $metric, MetricPoint $metricPoint)
|
||||
{
|
||||
|
||||
@@ -25,7 +25,7 @@ class SubscriberController extends AbstractApiController
|
||||
*
|
||||
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||
*
|
||||
* @return \Illuminate\Database\Eloquent\Collection
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function getSubscribers(Request $request)
|
||||
{
|
||||
@@ -37,7 +37,7 @@ class SubscriberController extends AbstractApiController
|
||||
/**
|
||||
* Create a new subscriber.
|
||||
*
|
||||
* @return \CachetHQ\Cachet\Models\Subscriber
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function postSubscribers()
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user