Fern: add TypeScript code examples (#3839)

This commit is contained in:
Stanislav Novosad
2025-10-28 17:43:19 -06:00
committed by GitHub
parent 47899085cf
commit d1008959b0
5 changed files with 549 additions and 85 deletions

View File

@@ -6,10 +6,14 @@ from fastapi.responses import ORJSONResponse
from skyvern import analytics
from skyvern.forge import app
from skyvern.forge.sdk.routes.code_samples import (
CLOSE_BROWSER_SESSION_CODE_SAMPLE,
CREATE_BROWSER_SESSION_CODE_SAMPLE,
GET_BROWSER_SESSION_CODE_SAMPLE,
GET_BROWSER_SESSIONS_CODE_SAMPLE,
CLOSE_BROWSER_SESSION_CODE_SAMPLE_PYTHON,
CLOSE_BROWSER_SESSION_CODE_SAMPLE_TS,
CREATE_BROWSER_SESSION_CODE_SAMPLE_PYTHON,
CREATE_BROWSER_SESSION_CODE_SAMPLE_TS,
GET_BROWSER_SESSION_CODE_SAMPLE_PYTHON,
GET_BROWSER_SESSION_CODE_SAMPLE_TS,
GET_BROWSER_SESSIONS_CODE_SAMPLE_PYTHON,
GET_BROWSER_SESSIONS_CODE_SAMPLE_TS,
)
from skyvern.forge.sdk.routes.routers import base_router
from skyvern.forge.sdk.schemas.organizations import Organization
@@ -56,7 +60,14 @@ async def get_browser_sessions_all(
tags=["Browser Sessions"],
openapi_extra={
"x-fern-sdk-method-name": "create_browser_session",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": CREATE_BROWSER_SESSION_CODE_SAMPLE}]}],
"x-fern-examples": [
{
"code-samples": [
{"sdk": "python", "code": CREATE_BROWSER_SESSION_CODE_SAMPLE_PYTHON},
{"sdk": "typescript", "code": CREATE_BROWSER_SESSION_CODE_SAMPLE_TS},
]
}
],
},
description="Create a browser session that persists across multiple runs",
summary="Create a session",
@@ -87,7 +98,14 @@ async def create_browser_session(
tags=["Browser Sessions"],
openapi_extra={
"x-fern-sdk-method-name": "close_browser_session",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": CLOSE_BROWSER_SESSION_CODE_SAMPLE}]}],
"x-fern-examples": [
{
"code-samples": [
{"sdk": "python", "code": CLOSE_BROWSER_SESSION_CODE_SAMPLE_PYTHON},
{"sdk": "typescript", "code": CLOSE_BROWSER_SESSION_CODE_SAMPLE_TS},
]
}
],
},
description="Close a session. Once closed, the session cannot be used again.",
summary="Close a session",
@@ -122,7 +140,14 @@ async def close_browser_session(
tags=["Browser Sessions"],
openapi_extra={
"x-fern-sdk-method-name": "get_browser_session",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": GET_BROWSER_SESSION_CODE_SAMPLE}]}],
"x-fern-examples": [
{
"code-samples": [
{"sdk": "python", "code": GET_BROWSER_SESSION_CODE_SAMPLE_PYTHON},
{"sdk": "typescript", "code": GET_BROWSER_SESSION_CODE_SAMPLE_TS},
]
}
],
},
description="Get details about a specific browser session, including the browser address for cdp connection.",
summary="Get a session",
@@ -159,7 +184,14 @@ async def get_browser_session(
tags=["Browser Sessions"],
openapi_extra={
"x-fern-sdk-method-name": "get_browser_sessions",
"x-fern-examples": [{"code-samples": [{"sdk": "python", "code": GET_BROWSER_SESSIONS_CODE_SAMPLE}]}],
"x-fern-examples": [
{
"code-samples": [
{"sdk": "python", "code": GET_BROWSER_SESSIONS_CODE_SAMPLE_PYTHON},
{"sdk": "typescript", "code": GET_BROWSER_SESSIONS_CODE_SAMPLE_TS},
]
}
],
},
description="Get all active browser sessions for the organization",
summary="Get active browser sessions",