enhance(logs): explain log encoding

go-vela · Feb 29, 2024 · b4d4302 · b4d4302
1 parent 1416689
commit b4d4302
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/content/reference/api/build/logs.md b/content/reference/api/build/logs.md
@@ -69,3 +69,9 @@ curl \
   }
 ]
 ```
+
+The `data` field is base64 encoded. To decode the data, you can use the following command:
+
+```sh
+echo "SGVsbG8sIFdvcmxkIQ==" | base64 --decode
+```
diff --git a/content/reference/api/service/logs.md b/content/reference/api/service/logs.md
@@ -61,3 +61,9 @@ curl \
   "data": "SGVsbG8sIFdvcmxkIQ=="
 }
 ```
+
+The `data` field is base64 encoded. To decode the data, you can use the following command:
+
+```sh
+echo "SGVsbG8sIFdvcmxkIQ==" | base64 --decode
+```
diff --git a/content/reference/api/step/logs.md b/content/reference/api/step/logs.md
@@ -61,3 +61,9 @@ curl \
   "data": "SGVsbG8sIFdvcmxkIQ=="
 }
 ```
+
+The `data` field is base64 encoded. To decode the data, you can use the following command:
+
+```sh
+echo "SGVsbG8sIFdvcmxkIQ==" | base64 --decode
+```
-Original file line number
+Diff line change
@@ Expand Up / @@ -69,3 +69,9 @@ curl \ @@
       }
     ]
     ```
+    The `data` field is base64 encoded. To decode the data, you can use the following command:
+    ```sh
+    echo "SGVsbG8sIFdvcmxkIQ==" | base64 --decode
+    ```