Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-09 03:14:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

INA-5 | Update docs

Browse Source
This commit is contained in:
Nikola Cirkovic 2022-05-30 20:44:59 +02:00
parent 3c22a097b2
commit ea8325fbe7
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
app/Http/Controllers/OpenAPI/TaskSchedulerSchema.php
View File

@ -10,11 +10,12 @@
* @OA\Property(property="paused",type="boolean",example="false",description="The scheduler paused state"), * @OA\Property(property="paused",type="boolean",example="false",description="The scheduler paused state"),
* @OA\Property(property="repeat_every",type="string",example="DAY",description="Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)"), * @OA\Property(property="repeat_every",type="string",example="DAY",description="Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)"),
* @OA\Property(property="start_from",type="integer",example="1652898504",description="Timestamp when we should start the scheduler, default is today"), * @OA\Property(property="start_from",type="integer",example="1652898504",description="Timestamp when we should start the scheduler, default is today"),
* @OA\Property(property="date_range", type="string", example="last7", description="The string representation of the date range of data to be returned"), * @OA\Property(property="job",type="string",example="create_credit_report",description="Job, we can find list of available jobs in Scheduler model"),
* @OA\Property(property="date_key", type="string", example="created_at", description="The date column to search between."), * @OA\Property(property="date_range", type="string", example="last7", description="The string representation of the date range of data to be returned"),
* @OA\Property(property="start_date", type="string", example="2022-10-31", description="The start date to search between"), * @OA\Property(property="date_key", type="string", example="created_at", description="The date column to search between."),
* @OA\Property(property="end_date", type="string", example="2022-10-31", description="The end date to search between"), * @OA\Property(property="start_date", type="string", example="2022-10-31", description="The start date to search between"),
* @OA\Property( * @OA\Property(property="end_date", type="string", example="2022-10-31", description="The end date to search between"),
* @OA\Property(
* property="report_keys", * property="report_keys",
* type="array", * type="array",
* @OA\Items( * @OA\Items(
@ -33,10 +34,14 @@
* schema="UpdateTaskSchedulerSchema", * schema="UpdateTaskSchedulerSchema",
* type="object", * type="object",
* *
* @OA\Property(property="paused",type="boolean",example="false",description="The scheduler paused state"), * @OA\Property(property="paused",type="boolean",example="false",description="The scheduler paused state"),
* * @OA\Property(property="repeat_every",type="string",example="DAY",description="Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)"), * @OA\Property(property="repeat_every",type="string",example="DAY",description="Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)"),
* @OA\Property(property="start_from",type="integer",example="1652898504",description="Timestamp when we should start the scheduler, default is today"), * @OA\Property(property="start_from",type="integer",example="1652898504",description="Timestamp when we should start the scheduler, default is today"),
* * @OA\Property(property="job",type="string",example="create_credit_report",description="Job, we can find list of available jobs in Scheduler model"),
* @OA\Property(property="date_range", type="string", example="last7", description="The string representation of the date range of data to be returned"),
* @OA\Property(property="date_key", type="string", example="created_at", description="The date column to search between."),
* @OA\Property(property="start_date", type="string", example="2022-10-31", description="The start date to search between"),
* @OA\Property(property="end_date", type="string", example="2022-10-31", description="The end date to search between"),
* ) * )
*/ */
@ -44,7 +49,7 @@
* @OA\Schema( * @OA\Schema(
* schema="UpdateJobForASchedulerSchema", * schema="UpdateJobForASchedulerSchema",
* type="object", * type="object",
* @OA\Property(property="job",type="string",example="create_client_report",description="Set action name, action names can be found in ScheduledJob Model"), * @OA\Property(property="job",type="string",example="create_client_report",description="Set action name, action names can be found in Scheduler Model"),
* *
* ) * )
*/ */