Skip to content

Commit

Permalink
remove default values in api param docs
Browse files Browse the repository at this point in the history 
Signed-off-by: Julien Veyssier <[email protected]>
  • Loading branch information
@julien-nc
julien-nc committed Apr 3, 2024
1 parent c378086 commit a6fdd97
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 28 deletions.
4 changes: 2 additions & 2 deletions lib/Controller/AssistantApiController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ public function getAssistantTask(int $metaTaskId): DataResponse {
*
* Get a list of assistant tasks for the current user.
*
* @param string|null $taskType Task type id. If null, tasks of all task types will be retrieved (default: null)
* @param int|null $category Task category. If null, tasks of all categories will be retrieved (default: null)
* @param string|null $taskType Task type id. If null, tasks of all task types will be retrieved
* @param int|null $category Task category. If null, tasks of all categories will be retrieved
* @return DataResponse<Http::STATUS_OK, array{tasks: array<AssistantTask>}, array{}>|DataResponse<Http::STATUS_NOT_FOUND, '', array{}>
*
* 200: User tasks returned
Expand Down
8 changes: 4 additions & 4 deletions lib/Controller/Text2ImageApiController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ public function __construct(
* @param string $appId App id to be set in the created task
* @param string $identifier Identifier to be set in the created task
* @param string $prompt Input prompt for the image
* @param int $nResults Number of images to generate (default: 1)
* @param bool $displayPrompt Option to include the prompt when displaying the result images (default: false)
* @param bool $notifyReadyIfScheduled Whether a notification will be produced when the tasks has run if it was scheduled (default: false)
* @param bool $schedule Force scheduling even if the task could run synchronously (default: false)
* @param int $nResults Number of images to generate
* @param bool $displayPrompt Option to include the prompt when displaying the result images
* @param bool $notifyReadyIfScheduled Whether a notification will be produced when the tasks has run if it was scheduled
* @param bool $schedule Force scheduling even if the task could run synchronously
* @return DataResponse<Http::STATUS_OK, array{task: AssistantImageProcessPromptResponse}, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error: string}, array{}>
*
* 200: Task started successfully
Expand Down
44 changes: 22 additions & 22 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -327,12 +327,12 @@
{
"name": "metaTaskId",
"in": "path",
"description": "ID of the task",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
"description": "ID of the task"
},
{
"name": "OCS-APIRequest",
Expand Down Expand Up @@ -447,12 +447,12 @@
{
"name": "metaTaskId",
"in": "path",
"description": "ID of the task",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
"description": "ID of the task"
},
{
"name": "OCS-APIRequest",
Expand Down Expand Up @@ -549,7 +549,7 @@
{
"name": "taskType",
"in": "query",
"description": "Task type id. If null, tasks of all task types will be retrieved (default: null)",
"description": "Task type id. If null, tasks of all task types will be retrieved",
"schema": {
"type": "string",
"nullable": true
Expand All @@ -558,7 +558,7 @@
{
"name": "category",
"in": "query",
"description": "Task category. If null, tasks of all categories will be retrieved (default: null)",
"description": "Task category. If null, tasks of all categories will be retrieved",
"schema": {
"type": "integer",
"format": "int64",
Expand Down Expand Up @@ -1260,12 +1260,12 @@
{
"name": "metaTaskId",
"in": "path",
"description": "ID of the task",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
"description": "ID of the task"
},
{
"name": "OCS-APIRequest",
Expand Down Expand Up @@ -1388,7 +1388,7 @@
{
"name": "nResults",
"in": "query",
"description": "Number of images to generate (default: 1)",
"description": "Number of images to generate",
"schema": {
"type": "integer",
"format": "int64",
Expand All @@ -1398,7 +1398,7 @@
{
"name": "displayPrompt",
"in": "query",
"description": "Option to include the prompt when displaying the result images (default: false)",
"description": "Option to include the prompt when displaying the result images",
"schema": {
"type": "integer",
"default": 0,
Expand All @@ -1411,7 +1411,7 @@
{
"name": "notifyReadyIfScheduled",
"in": "query",
"description": "Whether a notification will be produced when the tasks has run if it was scheduled (default: false)",
"description": "Whether a notification will be produced when the tasks has run if it was scheduled",
"schema": {
"type": "integer",
"default": 0,
Expand All @@ -1424,7 +1424,7 @@
{
"name": "schedule",
"in": "query",
"description": "Force scheduling even if the task could run synchronously (default: false)",
"description": "Force scheduling even if the task could run synchronously",
"schema": {
"type": "integer",
"default": 0,
Expand Down Expand Up @@ -1569,11 +1569,11 @@
{
"name": "imageGenId",
"in": "path",
"description": "ID of the generation info",
"required": true,
"schema": {
"type": "string"
}
},
"description": "ID of the generation info"
},
{
"name": "OCS-APIRequest",
Expand Down Expand Up @@ -1766,21 +1766,21 @@
{
"name": "imageGenId",
"in": "path",
"description": "ID of the image generation",
"required": true,
"schema": {
"type": "string"
}
},
"description": "ID of the image generation"
},
{
"name": "fileNameId",
"in": "path",
"description": "ID of the file name",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
"description": "ID of the file name"
},
{
"name": "OCS-APIRequest",
Expand Down Expand Up @@ -2050,11 +2050,11 @@
{
"name": "imageGenId",
"in": "path",
"description": "ID of the image generation",
"required": true,
"schema": {
"type": "string"
}
},
"description": "ID of the image generation"
},
{
"name": "OCS-APIRequest",
Expand Down Expand Up @@ -2247,11 +2247,11 @@
{
"name": "imageGenId",
"in": "path",
"description": "ID of the image generation",
"required": true,
"schema": {
"type": "string"
}
},
"description": "ID of the image generation"
},
{
"name": "OCS-APIRequest",
Expand Down

0 comments on commit a6fdd97

Please sign in to comment.