new units api's task definition added

thoth-tech · Aug 27, 2024 · 7ab956d · 7ab956d
1 parent 62569a5
commit 7ab956d
Showing 1 changed file with 151 additions and 0 deletions.
diff --git a/src/content/docs/backend/API/api-task_definitions.md b/src/content/docs/backend/API/api-task_definitions.md
@@ -12,6 +12,11 @@ This "units" API has the following operations.
 - **DELETE**: /api/units/{unit_id}/task_definitions/{task_def_id}/tii_group_attachments/{id}
 - **PUT**: /api/units/{unit_id}/task_definitions/{task_def_id}/tii_group_attachments/{id}
 - **GET**: /api/units/{unit_id}/task_definitions/{task_def_id}/tii_group_attachments
+- **DELETE**: /api/units/{unit_id}/task_definitions/{task_def_id}/task_resources
+- **GET**: /api/units/{unit_id}/task_definitions/{task_def_id}/task_resources
+- **POST**: /api/units/{unit_id}/task_definitions/{task_def_id}/task_resources
+- **POST**: /api/units/{unit_id}/task_definitions/{task_def_id}/task_sheet
+- **POST**: /api/units/{unit_id}/task_definitions/{task_def_id}/test_overseer_assessment
 
 ## Detail of Operations related to units.
 
@@ -116,3 +121,149 @@ DELETE /units/{unit_id}/task_definitions/{task_def_id}/tii_group_attachments/{id
   ```
   true
   ```
+
+### DELETE: Remove the task resources for a given task
+
+DELETE /units/{unit_id}/task_definitions/{task_def_id}/task_resources
+
+- URL: `/units/{unit_id}/task_definitions/{task_def_id}/task_resources`
+- Method: `DELETE`
+- Parameters:
+  | Parameter  | Description          |Parameter Type| Data Type|Mandatory|
+  |------------|----------------------|--------------|----------|---------|
+  |unit_id     | Unit ID              | path         | integer  |Yes      |
+  |task_def_id | Task Definition ID   | path         | integer  |Yes      |
+  |Username    | User username        | header       | string   |Yes      |
+  |Auth_Token  | Authentication token | header       | string   |Yes      |
+
+- Response:
+  `204`
+
+- Example Request:
+
+  ```bash
+  curl -X DELETE --header 'Accept: application/json' --header 'Username: aadmin' --header 'Auth_Token: yzRDggcmzbVnYEbszVV1' 'http://localhost:3000/units/1/task_definitions/1/task_resources'
+  ```
+
+- Response body:
+  ```
+  true
+  ```
+
+### GET: Download the task resources
+
+GET /units/{unit_id}/task_definitions/{task_def_id}/task_resources
+
+- URL: `/units/{unit_id}/task_definitions/{task_def_id}/task_resources`
+- Method: `GET`
+- Parameters:
+  | Parameter  | Description          |Parameter Type| Data Type|Mandatory|
+  |------------|----------------------|--------------|----------|---------|
+  |unit_id     | Unit ID              | path         | integer  |Yes      |
+  |task_def_id | Task Definition ID   | path         | integer  |Yes      |
+  |Username    | User username        | header       | string   |Yes      |
+  |Auth_Token  | Authentication token | header       | string   |Yes      |
+
+- Response:
+  `200 OK`
+
+- Example Request:
+
+  ```bash
+  curl -X GET --header 'Accept: application/json' --header 'Username: aadmin' --header 'Auth_Token: yzRDggcmzbVnYEbszVV1' 'http://localhost:3000/units/1/task_definitions/1/task_resources'
+  ```
+
+- Response body:
+  ```
+  <binary data of the zip file>
+  ```
+
+### POST: Upload the task resources for a given task
+
+POST /units/{unit_id}/task_definitions/{task_def_id}/task_resources
+
+- URL: `/units/{unit_id}/task_definitions/{task_def_id}/task_resources`
+- Method: `POST`
+- Parameters:
+  | Parameter  | Description          |Parameter Type| Data Type|Mandatory|
+  |------------|----------------------|--------------|----------|---------|
+  |unit_id     | Unit ID              | path         | integer  |Yes      |
+  |task_def_id | Task Definition ID   | path         | integer  |Yes      |
+  |Username    | User username        | header       | string   |Yes      |
+  |Auth_Token  | Authentication token | header       | string   |Yes      |
+  |file        | Task resources zip   | form-data    | file     |Yes      |
+
+- Response:
+  `200 OK`
+
+- Example Request:
+
+  ```bash
+  curl -X POST --header 'Accept: application/json' --header 'Username: aadmin' --header 'Auth_Token: yzRDggcmzbVnYEbszVV1' -F "file=@/path/to/resources.zip" 'http://localhost:3000/units/1/task_definitions/1/task_resources'
+  ```
+
+- Response body:
+  ```
+  true
+  ```
+
+### POST: Upload the task sheet for a given task
+
+POST /units/{unit_id}/task_definitions/{task_def_id}/task_sheet
+
+- URL: `/units/{unit_id}/task_definitions/{task_def_id}/task_sheet`
+- Method: `POST`
+- Parameters:
+  | Parameter  | Description          |Parameter Type| Data Type|Mandatory|
+  |------------|----------------------|--------------|----------|---------|
+  |unit_id     | Unit ID              | path         | integer  |Yes      |
+  |task_def_id | Task Definition ID   | path         | integer  |Yes      |
+  |Username    | User username        | header       | string   |Yes      |
+  |Auth_Token  | Authentication token | header       | string   |Yes      |
+  |file        | Task resources zip   | form-data    | file     |Yes      |
+
+- Response:
+  `200 OK`
+
+- Example Request:
+
+  ```bash
+  curl -X POST --header 'Accept: application/json' --header 'Username: aadmin' --header 'Auth_Token: yzRDggcmzbVnYEbszVV1' -F "file=@/path/to/task_sheet.pdf" 'http://localhost:3000/units/1/task_definitions/1/task_sheet'
+  ```
+
+- Response body:
+  ```
+  true
+  ```
+
+### POST: Test overseer assessment for a given task
+
+POST /units/{unit_id}/task_definitions/{task_def_id}/test_overseer_assessment
+
+- URL: `/units/{unit_id}/task_definitions/{task_def_id}/test_overseer_assessment`
+- Method: `POST`
+- Parameters:
+  | Parameter  | Description          |Parameter Type| Data Type|Mandatory|
+  |------------|----------------------|--------------|----------|---------|
+  |unit_id     | Unit ID              | path         | integer  |Yes      |
+  |task_def_id | Task Definition ID   | path         | integer  |Yes      |
+  |Username    | User username        | header       | string   |Yes      |
+  |Auth_Token  | Authentication token | header       | string   |Yes      |
+  |file 0      | File 0 (optional)    | form-data    | file     |No       |
+  |file 1      | File 1 (optional)    | form-data    | file     |No       |
+
+- Response:
+  `200 OK`
+
+- Example Request:
+
+  ```bash
+  curl -X POST --header 'Accept: application/json' --header 'Username: aadmin' --header 'Auth_Token: yzRDggcmzbVnYEbszVV1' -F "file0=@/path/to/file0" -F "file1=@/path/to/file1" 'http://localhost:3000/units/1/task_definitions/1/test_overseer_assessment'
+  ```
+
+- Response body:
+  ```json
+  {
+    "status": "Overseer assessment performed successfully"
+  }
+  ```