Skip to content

Commit 83d8cd3

Browse files
docs(api): update annotations parameter examples in agents
1 parent fe40b6e commit 83d8cd3

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 193
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-81e6dd362ed000dd15cc51a77545a0772d791241380906229b5ba6f2ba265bcb.yml
3-
openapi_spec_hash: 9adc025d621dcefde671682cdd711ec0
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-eb2a06fb4bcfb9dc85e08216cdaad259453be5d03dd6cdd0562e147d33a8ff31.yml
3+
openapi_spec_hash: 0d278e84539c7e554d6218666aa3bf41
44
config_hash: 1e3edbeecb529f712bfaac1b561d91d5

src/gitpod/resources/agents.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -581,9 +581,9 @@ def start_execution(
581581
```
582582
583583
Args:
584-
annotations: annotations are key-value pairs for tracking external context (e.g., Linear
584+
annotations: annotations are key-value pairs for tracking external context (e.g., integration
585585
session IDs, GitHub issue references). Keys should follow domain/name convention
586-
(e.g., "linear.app/session-id").
586+
(e.g., "agent-client-session/id").
587587
588588
mode: mode specifies the operational mode for this agent execution If not specified,
589589
defaults to AGENT_MODE_EXECUTION
@@ -1262,9 +1262,9 @@ async def start_execution(
12621262
```
12631263
12641264
Args:
1265-
annotations: annotations are key-value pairs for tracking external context (e.g., Linear
1265+
annotations: annotations are key-value pairs for tracking external context (e.g., integration
12661266
session IDs, GitHub issue references). Keys should follow domain/name convention
1267-
(e.g., "linear.app/session-id").
1267+
(e.g., "agent-client-session/id").
12681268
12691269
mode: mode specifies the operational mode for this agent execution If not specified,
12701270
defaults to AGENT_MODE_EXECUTION

src/gitpod/types/agent_start_execution_params.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ class AgentStartExecutionParams(TypedDict, total=False):
1717

1818
annotations: Dict[str, str]
1919
"""
20-
annotations are key-value pairs for tracking external context (e.g., Linear
20+
annotations are key-value pairs for tracking external context (e.g., integration
2121
session IDs, GitHub issue references). Keys should follow domain/name convention
22-
(e.g., "linear.app/session-id").
22+
(e.g., "agent-client-session/id").
2323
"""
2424

2525
code_context: Annotated[AgentCodeContextParam, PropertyInfo(alias="codeContext")]

0 commit comments

Comments
 (0)