Skip to content

Commit f8a2a44

Browse files
feat(api): manual updates (#61)
1 parent 896ccd0 commit f8a2a44

23 files changed

+1933
-291
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 111
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-cd6a05ae99d2a050577fa0e729e6ae89b4eacd78f61366a77269398368f8a877.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-d6a243325df36817d495ce6dd54f80766b77a97e1ca2f6d371c0a68b7d070e0f.yml

src/gitpod/resources/events.py

Lines changed: 86 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,32 @@ def list(
6262
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
6363
) -> SyncEntriesPage[EventListResponse]:
6464
"""
65-
ListAuditLogs retrieves a paginated list of audit logs for the specified
66-
organization
65+
Lists audit logs with filtering and pagination options.
66+
67+
Use this method to:
68+
69+
- View audit history
70+
- Track user actions
71+
- Monitor system changes
72+
73+
### Examples
74+
75+
- List all logs:
76+
77+
```yaml
78+
pagination:
79+
pageSize: 20
80+
```
81+
82+
- Filter by actor:
83+
84+
```yaml
85+
filter:
86+
actorIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
87+
actorPrincipals: ["PRINCIPAL_USER"]
88+
pagination:
89+
pageSize: 20
90+
```
6791
6892
Args:
6993
pagination: pagination contains the pagination options for listing environments
@@ -116,7 +140,23 @@ def watch(
116140
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
117141
) -> JSONLDecoder[EventWatchResponse]:
118142
"""
119-
WatchEvents streams all requests events to the client
143+
Streams events for all projects, runners, environments, tasks, and services
144+
based on the specified scope.
145+
146+
Use this method to:
147+
148+
- Monitor resource changes in real-time
149+
- Track system events
150+
- Receive notifications
151+
152+
The scope parameter determines which events to watch:
153+
154+
- Organization scope (default): Watch all organization-wide events including
155+
projects, runners and environments. Task and service events are not included.
156+
Use by setting organization=true or omitting the scope.
157+
- Environment scope: Watch events for a specific environment, including its
158+
tasks, task executions, and services. Use by setting environment_id to the
159+
UUID of the environment to watch.
120160
121161
Args:
122162
environment_id: Environment scope produces events for the environment itself, all tasks, task
@@ -187,8 +227,32 @@ def list(
187227
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
188228
) -> AsyncPaginator[EventListResponse, AsyncEntriesPage[EventListResponse]]:
189229
"""
190-
ListAuditLogs retrieves a paginated list of audit logs for the specified
191-
organization
230+
Lists audit logs with filtering and pagination options.
231+
232+
Use this method to:
233+
234+
- View audit history
235+
- Track user actions
236+
- Monitor system changes
237+
238+
### Examples
239+
240+
- List all logs:
241+
242+
```yaml
243+
pagination:
244+
pageSize: 20
245+
```
246+
247+
- Filter by actor:
248+
249+
```yaml
250+
filter:
251+
actorIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
252+
actorPrincipals: ["PRINCIPAL_USER"]
253+
pagination:
254+
pageSize: 20
255+
```
192256
193257
Args:
194258
pagination: pagination contains the pagination options for listing environments
@@ -241,7 +305,23 @@ async def watch(
241305
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
242306
) -> AsyncJSONLDecoder[EventWatchResponse]:
243307
"""
244-
WatchEvents streams all requests events to the client
308+
Streams events for all projects, runners, environments, tasks, and services
309+
based on the specified scope.
310+
311+
Use this method to:
312+
313+
- Monitor resource changes in real-time
314+
- Track system events
315+
- Receive notifications
316+
317+
The scope parameter determines which events to watch:
318+
319+
- Organization scope (default): Watch all organization-wide events including
320+
projects, runners and environments. Task and service events are not included.
321+
Use by setting organization=true or omitting the scope.
322+
- Environment scope: Watch events for a specific environment, including its
323+
tasks, task executions, and services. Use by setting environment_id to the
324+
UUID of the environment to watch.
245325
246326
Args:
247327
environment_id: Environment scope produces events for the environment itself, all tasks, task

src/gitpod/resources/groups.py

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,35 @@ def list(
5656
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
5757
) -> SyncGroupsPage[Group]:
5858
"""
59-
ListGroups lists groups
59+
Lists groups with optional pagination.
60+
61+
Use this method to:
62+
63+
- View all groups
64+
- Check group memberships
65+
- Monitor group configurations
66+
- Audit group access
67+
68+
### Examples
69+
70+
- List all groups:
71+
72+
Shows all groups with pagination.
73+
74+
```yaml
75+
pagination:
76+
pageSize: 20
77+
```
78+
79+
- List with custom page size:
80+
81+
Shows groups with specified page size.
82+
83+
```yaml
84+
pagination:
85+
pageSize: 50
86+
token: "next-page-token-from-previous-response"
87+
```
6088
6189
Args:
6290
pagination: pagination contains the pagination options for listing groups
@@ -125,7 +153,35 @@ def list(
125153
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
126154
) -> AsyncPaginator[Group, AsyncGroupsPage[Group]]:
127155
"""
128-
ListGroups lists groups
156+
Lists groups with optional pagination.
157+
158+
Use this method to:
159+
160+
- View all groups
161+
- Check group memberships
162+
- Monitor group configurations
163+
- Audit group access
164+
165+
### Examples
166+
167+
- List all groups:
168+
169+
Shows all groups with pagination.
170+
171+
```yaml
172+
pagination:
173+
pageSize: 20
174+
```
175+
176+
- List with custom page size:
177+
178+
Shows groups with specified page size.
179+
180+
```yaml
181+
pagination:
182+
pageSize: 50
183+
token: "next-page-token-from-previous-response"
184+
```
129185
130186
Args:
131187
pagination: pagination contains the pagination options for listing groups

0 commit comments

Comments
 (0)