docs: task manager add open api

Signed-off-by: zhaoxinxin <[email protected]>
dragonflyoss · Nov 19, 2024 · 9d2aa68 · 9d2aa68
1 parent ae483ee
commit 9d2aa68
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/docs/advanced-guides/preheat.md b/docs/advanced-guides/preheat.md
@@ -47,7 +47,6 @@ curl --location --request POST 'http://dragonfly-manager:8080/oapi/v1/jobs' \
     "args": {
         "type": "image",
         "url": "https://index.docker.io/v2/library/alpine/manifests/3.19",
-        "filteredQueryParams": "Expires&Signature",
         "username": "your_registry_username",
         "password": "your_registry_password",
         "scope": "single_peer" or "all_peers"
@@ -66,7 +65,7 @@ The command-line log returns the preheat job id.
   "type": "preheat",
   "state": "PENDING",
   "args": {
-    "filteredQueryParams": "Expires&Signature",
+    "filteredQueryParams": "",
     "headers": null,
     "password": "",
     "pieceLength": 4194304,
@@ -106,7 +105,7 @@ If the status is `SUCCESS`, the preheating is successful.
   "type": "preheat",
   "state": "SUCCESS",
   "args": {
-    "filteredQueryParams": "Expires&Signature",
+    "filteredQueryParams": "",
     "headers": null,
     "password": "",
     "pieceLength": 4194304,
@@ -159,7 +158,7 @@ The command-line log returns the preheat job id.
   "type": "preheat",
   "state": "PENDING",
   "args": {
-    "filteredQueryParams": "Expires&Signature",
+    "filteredQueryParams": "",
     "headers": null,
     "password": "",
     "pieceLength": 4194304,
@@ -199,7 +198,7 @@ If the status is `SUCCESS`, the preheating is successful.
   "type": "preheat",
   "state": "SUCCESS",
   "args": {
-    "filteredQueryParams": "Expires&Signature",
+    "filteredQueryParams": "",
     "headers": null,
     "password": "",
     "pieceLength": 4194304,

diff --git a/docs/advanced-guides/task.md b/docs/advanced-guides/task.md
@@ -43,7 +43,6 @@ curl --location --request POST 'http://dragonfly-manager:8080/oapi/v1/jobs' \
     "type": "get_task",
     "args": {
         "url": "https://example.com",
-        "filtered_query_params": "Expires&Signature",
         "tag": "your_url_tag",
         "application": "your_url_application"
     }
@@ -157,9 +156,9 @@ curl --location --request POST 'http://dragonfly-manager:8080/oapi/v1/jobs' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer your_dragonfly_personal_access_token' \
 --data-raw '{
-    "type": "delete_task",
+    "type": "get_task",
     "args": {
-        "task_id": "cf0694b42447d5f1e3762ec94c488c58a4973dd4d503c35da570a194e473fe55"
+        "task_id": "your_task_id"
     }
 }'
 ```
@@ -278,7 +277,7 @@ curl --location --request POST 'http://dragonfly-manager:8080/oapi/v1/jobs' \
         "tag": "your_url_tag",
         "application": "your_url_application"
     },
-    "scheduler_cluster_ids":[scheduler_cluster_id]
+    "scheduler_cluster_ids":[your_scheduler_cluster_id]
 }'
 ```
 
@@ -387,7 +386,7 @@ curl --location --request POST 'http://dragonfly-manager:8080/oapi/v1/jobs' \
     "args": {
         "task_id": "your_task_id"
     },
-    "scheduler_cluster_ids":[scheduler_cluster_id]
+    "scheduler_cluster_ids":[your_scheduler_cluster_id]
 }'
 ```