Prechádzať zdrojové kódy

Add `include_task_info` and `show_deleted` query
parameters to `API docs`

Signed-off-by: Mihaela Balutoiu <mbalutoiu@cloudbasesolutions.com>

Mihaela Balutoiu 7 mesiacov pred
rodič
commit
e244288cd4

+ 3 - 0
coriolis/api-refs/source/deployment.inc

@@ -26,6 +26,8 @@ Response
 
   - deployments : deployments_array
   - id : deployment_id
+  - include_task_info : include_task_info
+  - show_deleted : show_deleted
   - deleted : deployment_deleted
   - deleted_at : deployment_deleted_at
   - instances : deployment_instances
@@ -88,6 +90,7 @@ Response
 
   - deployment : deployment_object
   - id : deployment_id
+  - include_task_info : include_task_info
   - deleted : deployment_deleted
   - deleted_at : deployment_deleted_at
   - instances : deployment_instances

+ 16 - 0
coriolis/api-refs/source/parameters.yaml

@@ -72,12 +72,28 @@ transfer_tasks_execution_id_path:
   type: uuid
   required: true
 # query variables
+include_task_info:
+  description: |
+    When set to true, the response will include comprehensive task details 
+    for transfers, deployments, and executions, including task statuses,
+    progress, and execution metadata.
+  in: query
+  required: false
+  type: boolean
+  default: false
 instance_limit:
   description: |
     Returns a number of items up to a limit value.
   in: query
   required: false
   type: integer
+show_deleted:
+  description: |
+    Whether to include deleted resources in the response.
+  in: query
+  required: false
+  type: boolean
+  default: false
 # body variables
 base_id:
   description: |

+ 3 - 0
coriolis/api-refs/source/transfer.inc

@@ -26,6 +26,8 @@ Response
 
   - transfers : transfers_array
   - id : transfer_id
+  - include_task_info: include_task_info
+  - show_deleted : show_deleted
   - deleted : transfer_deleted
   - deleted_at : transfer_deleted_at
   - executions : transfer_empty_execution_array
@@ -85,6 +87,7 @@ Response
 
   - transfer : transfer_object
   - id : transfer_id
+  - include_task_info: include_task_info
   - deleted : transfer_deleted
   - deleted_at : transfer_deleted_at
   - executions : transfer_execution_array