khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

enh(Text2Image): Add cross-references for task status values to OCS API docs

Browse Source 
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
This commit is contained in:
Marcel Klehr
2023-11-06 19:19:26 +01:00
parent 8725d5185a
commit e5a29f54bd
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
developer_manual/client_apis/OCS/ocs-text2image-api.rst
View File

@@ -65,7 +65,7 @@ If possible the task will be executed while the request is processed on the serv
- Data:
+ ``id`` - Only provided in case of ``200 OK``, the assigned task id, int
+ ``input`` - Only provided in case of ``200 OK``, the task input, string
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see backend API
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see :ref:`the backend Text-To-Image API<text2image_statuses>`
+ ``userId`` - Only provided in case of ``200 OK``, the originating userId of the task, string
+ ``appId`` - Only provided in case of ``200 OK``, the originating appId of the task, string
+ ``identifier`` - Only provided in case of ``200 OK``, the originating appId of the task, string
@@ -91,7 +91,7 @@ Fetch a task by ID
- Data:
+ ``id`` - Only provided in case of ``200 OK``, the assigned task id, int
+ ``input`` - Only provided in case of ``200 OK``, the task input, string
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see backend API
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see :ref:`the backend Text-To-Image API<text2image_statuses>`
+ ``userId`` - Only provided in case of ``200 OK``, the originating userId of the task, string
+ ``appId`` - Only provided in case of ``200 OK``, the originating appId of the task, string
+ ``identifier`` - Only provided in case of ``200 OK``, the originating appId of the task, string
@@ -131,7 +131,7 @@ Delete a task
- Data:
+ ``id`` - Only provided in case of ``200 OK``, the assigned task id, int
+ ``input`` - Only provided in case of ``200 OK``, the task input, string
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see backend API
+ ``status`` - Only provided in case of ``200 OK``, the current task status, int, see :ref:`the backend Text-To-Image API<text2image_statuses>`
+ ``userId`` - Only provided in case of ``200 OK``, the originating userId of the task, string
+ ``appId`` - Only provided in case of ``200 OK``, the originating appId of the task, string
+ ``identifier`` - Only provided in case of ``200 OK``, the originating appId of the task, string
@@ -167,7 +167,7 @@ List tasks by App
+ Only provided in case of ``200 OK``, an array of objects:
+ ``id`` - the assigned task id, int
+ ``input`` - the task input, string
+ ``status`` - the current task status, int, see backend API
+ ``status`` - the current task status, int, see :ref:`the backend Text-To-Image API<text2image_statuses>`
+ ``userId`` - the originating userId of the task, string
+ ``appId`` - the originating appId of the task, string
+ ``identifier`` - the originating appId of the task, string

2
developer_manual/digging_deeper/text2image.rst
View File

@@ -93,6 +93,8 @@ Of course, you might want to schedule the task in a background job **only** if i
Task statuses
^^^^^^^^^^^^^
.. _text2image_statuses:
All tasks always have one of the below statuses:
.. code-block:: php