ADM-715[docs]refactor: put branch in request body (#950)

au-heartbeat · Jan 17, 2024 · f8054f9 · f8054f9
1 parent 05767c7
commit f8054f9
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/docs/src/content/docs/en/spikes/tech-spikes-split-verification-of-github.mdx b/docs/src/content/docs/en/spikes/tech-spikes-split-verification-of-github.mdx
@@ -115,17 +115,23 @@ end
 Triggered when the user selects a branch in the Pipeline settings module of the Metrics page.
 
 - Api Design
+
 ```
-paths: /api/v1/source-control/{sourceType}/repos/branches/{branch}/verify
+paths: /api/v1/source-control/{sourceType}/repos/branches/verify
 method: post
 request: {
   repository: "[email protected]:XXXX/XXXX.git",
-  token: "..."
+  token: "...",
+  branch: "main"
 }
 responses:
   Status Code: 204
 ```
+
+Note：Since the branch name may contain special characters, which will cause the URL to be unsafe, put it in the request body.
+
 - GitHub Api for verification
+
 ```
 paths: https://api.github.com/repos/{owner}/{repo}/branches/{branch}
 method: get