Skip to content

Commit d93386f

Browse files
committed
Prefix auth description links with /docs
1 parent 2a12712 commit d93386f

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

openapi-public.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1939,10 +1939,10 @@ components:
19391939
in: header
19401940
name: X-Access-Token
19411941
description: 'Sandbox access token (`envdAccessToken`) for authenticating requests
1942-
to a running sandbox. Returned by: [POST /sandboxes](/api-reference/sandboxes/create-a-sandbox)
1943-
(on create), [POST /sandboxes/{sandboxID}/connect](/api-reference/sandboxes/connect-to-a-sandbox)
1944-
(on connect), [POST /sandboxes/{sandboxID}/resume](/api-reference/sandboxes/resume-a-sandbox)
1945-
(on resume), and [GET /sandboxes/{sandboxID}](/api-reference/sandboxes/get-a-sandbox)
1942+
to a running sandbox. Returned by: [POST /sandboxes](/docs/api-reference/sandboxes/create-a-sandbox)
1943+
(on create), [POST /sandboxes/{sandboxID}/connect](/docs/api-reference/sandboxes/connect-to-a-sandbox)
1944+
(on connect), [POST /sandboxes/{sandboxID}/resume](/docs/api-reference/sandboxes/resume-a-sandbox)
1945+
(on resume), and [GET /sandboxes/{sandboxID}](/docs/api-reference/sandboxes/get-a-sandbox)
19461946
(for running or paused sandboxes).'
19471947
parameters:
19481948
FilePath:

scripts/generate_openapi_reference.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -568,10 +568,10 @@ def setup_sandbox_auth_scheme(spec: dict[str, Any]) -> None:
568568
"description": (
569569
"Sandbox access token (`envdAccessToken`) for authenticating requests to a running sandbox. "
570570
"Returned by: "
571-
"[POST /sandboxes](/api-reference/sandboxes/create-a-sandbox) (on create), "
572-
"[POST /sandboxes/{sandboxID}/connect](/api-reference/sandboxes/connect-to-a-sandbox) (on connect), "
573-
"[POST /sandboxes/{sandboxID}/resume](/api-reference/sandboxes/resume-a-sandbox) (on resume), "
574-
"and [GET /sandboxes/{sandboxID}](/api-reference/sandboxes/get-a-sandbox) (for running or paused sandboxes)."
571+
"[POST /sandboxes](/docs/api-reference/sandboxes/create-a-sandbox) (on create), "
572+
"[POST /sandboxes/{sandboxID}/connect](/docs/api-reference/sandboxes/connect-to-a-sandbox) (on connect), "
573+
"[POST /sandboxes/{sandboxID}/resume](/docs/api-reference/sandboxes/resume-a-sandbox) (on resume), "
574+
"and [GET /sandboxes/{sandboxID}](/docs/api-reference/sandboxes/get-a-sandbox) (for running or paused sandboxes)."
575575
),
576576
}
577577

0 commit comments

Comments
 (0)