Skip to content

Commit 5929332

Browse files
docs(api): correct project-scoping descriptions in OpenAPI spec
1 parent 222b534 commit 5929332

14 files changed

Lines changed: 53 additions & 52 deletions

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 119
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-663f08b43eda6383b99ab0f3b1cd049d62f22c81daf149d8e84ff18f53c84c89.yml
3-
openapi_spec_hash: 29ea250251cc14d70e3f8f737ebc1466
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-c6458d9c6cb5d7e3d8309c79b69eba3a22269e0ecc0bdafbaee00fde4b302e99.yml
3+
openapi_spec_hash: ee77b293c4bda91c1a32cfdd12b8739e
44
config_hash: 80eef1b592110714ea55cd26c470fabb

src/kernel/resources/auth/connections.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ def create(
136136
137137
login_url: Optional login page URL to skip discovery
138138
139-
proxy: Proxy selection. Provide either id or name. The proxy must belong to the
140-
caller's org.
139+
proxy: Proxy selection. Provide either id or name. The proxy must be in the same
140+
project as the resource referencing it.
141141
142142
record_session: Whether to record browser sessions for this connection by default. Useful for
143143
debugging. Can be overridden per-login. Defaults to false.
@@ -264,8 +264,8 @@ def update(
264264
265265
login_url: Login page URL. Set to empty string to clear.
266266
267-
proxy: Proxy selection. Provide either id or name. The proxy must belong to the
268-
caller's org.
267+
proxy: Proxy selection. Provide either id or name. The proxy must be in the same
268+
project as the resource referencing it.
269269
270270
record_session: Whether to record browser sessions for this connection by default
271271
@@ -457,8 +457,8 @@ def login(
457457
credentials are stored.
458458
459459
Args:
460-
proxy: Proxy selection. Provide either id or name. The proxy must belong to the
461-
caller's org.
460+
proxy: Proxy selection. Provide either id or name. The proxy must be in the same
461+
project as the resource referencing it.
462462
463463
record_session: Override the connection's default for recording this login's browser session.
464464
When omitted, the connection's record_session default is used.
@@ -653,8 +653,8 @@ async def create(
653653
654654
login_url: Optional login page URL to skip discovery
655655
656-
proxy: Proxy selection. Provide either id or name. The proxy must belong to the
657-
caller's org.
656+
proxy: Proxy selection. Provide either id or name. The proxy must be in the same
657+
project as the resource referencing it.
658658
659659
record_session: Whether to record browser sessions for this connection by default. Useful for
660660
debugging. Can be overridden per-login. Defaults to false.
@@ -781,8 +781,8 @@ async def update(
781781
782782
login_url: Login page URL. Set to empty string to clear.
783783
784-
proxy: Proxy selection. Provide either id or name. The proxy must belong to the
785-
caller's org.
784+
proxy: Proxy selection. Provide either id or name. The proxy must be in the same
785+
project as the resource referencing it.
786786
787787
record_session: Whether to record browser sessions for this connection by default
788788
@@ -974,8 +974,8 @@ async def login(
974974
credentials are stored.
975975
976976
Args:
977-
proxy: Proxy selection. Provide either id or name. The proxy must belong to the
978-
caller's org.
977+
proxy: Proxy selection. Provide either id or name. The proxy must be in the same
978+
project as the resource referencing it.
979979
980980
record_session: Override the connection's default for recording this login's browser session.
981981
When omitted, the connection's record_session default is used.

src/kernel/resources/browser_pools.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ def create(
109109
specified, the matching profile will be loaded into the browser session.
110110
Profiles must be created beforehand.
111111
112-
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy
113-
belonging to the caller's org.
112+
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy in
113+
the same project as the browser session.
114114
115115
start_url: Optional URL to navigate to when a new browser is warmed into the pool.
116116
Best-effort: failures to navigate do not fail pool fill. Only applied to
@@ -256,8 +256,8 @@ def update(
256256
specified, the matching profile will be loaded into the browser session.
257257
Profiles must be created beforehand.
258258
259-
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy
260-
belonging to the caller's org.
259+
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy in
260+
the same project as the browser session.
261261
262262
size: Number of browsers to maintain in the pool. The maximum size is determined by
263263
your organization's pooled sessions limit (the sum of all pool sizes cannot
@@ -338,7 +338,7 @@ def list(
338338
timeout: float | httpx.Timeout | None | NotGiven = not_given,
339339
) -> SyncOffsetPagination[BrowserPool]:
340340
"""
341-
List browser pools owned by the caller's organization.
341+
List browser pools in the resolved project.
342342
343343
Args:
344344
limit: Limit the number of browser pools to return.
@@ -630,8 +630,8 @@ async def create(
630630
specified, the matching profile will be loaded into the browser session.
631631
Profiles must be created beforehand.
632632
633-
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy
634-
belonging to the caller's org.
633+
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy in
634+
the same project as the browser session.
635635
636636
start_url: Optional URL to navigate to when a new browser is warmed into the pool.
637637
Best-effort: failures to navigate do not fail pool fill. Only applied to
@@ -777,8 +777,8 @@ async def update(
777777
specified, the matching profile will be loaded into the browser session.
778778
Profiles must be created beforehand.
779779
780-
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy
781-
belonging to the caller's org.
780+
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy in
781+
the same project as the browser session.
782782
783783
size: Number of browsers to maintain in the pool. The maximum size is determined by
784784
your organization's pooled sessions limit (the sum of all pool sizes cannot
@@ -859,7 +859,7 @@ def list(
859859
timeout: float | httpx.Timeout | None | NotGiven = not_given,
860860
) -> AsyncPaginator[BrowserPool, AsyncOffsetPagination[BrowserPool]]:
861861
"""
862-
List browser pools owned by the caller's organization.
862+
List browser pools in the resolved project.
863863
864864
Args:
865865
limit: Limit the number of browser pools to return.

src/kernel/resources/browsers/browsers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@ def create(
216216
specified, the matching profile will be loaded into the browser session.
217217
Profiles must be created beforehand.
218218
219-
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy
220-
belonging to the caller's org.
219+
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy in
220+
the same project as the browser session.
221221
222222
start_url: Optional URL to open when the browser session is created. Navigation is
223223
best-effort, so navigation failures do not prevent the session from being
@@ -794,8 +794,8 @@ async def create(
794794
specified, the matching profile will be loaded into the browser session.
795795
Profiles must be created beforehand.
796796
797-
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy
798-
belonging to the caller's org.
797+
proxy_id: Optional proxy to associate to the browser session. Must reference a proxy in
798+
the same project as the browser session.
799799
800800
start_url: Optional URL to open when the browser session is created. Navigation is
801801
best-effort, so navigation failures do not prevent the session from being

src/kernel/resources/credentials.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,9 @@ def list(
212212
extra_body: Body | None = None,
213213
timeout: float | httpx.Timeout | None | NotGiven = not_given,
214214
) -> SyncOffsetPagination[Credential]:
215-
"""List credentials owned by the caller's organization.
215+
"""List credentials in the resolved project.
216216
217-
Credential values are not
218-
returned.
217+
Credential values are not returned.
219218
220219
Args:
221220
domain: Filter by domain
@@ -509,10 +508,9 @@ def list(
509508
extra_body: Body | None = None,
510509
timeout: float | httpx.Timeout | None | NotGiven = not_given,
511510
) -> AsyncPaginator[Credential, AsyncOffsetPagination[Credential]]:
512-
"""List credentials owned by the caller's organization.
511+
"""List credentials in the resolved project.
513512
514-
Credential values are not
515-
returned.
513+
Credential values are not returned.
516514
517515
Args:
518516
domain: Filter by domain

src/kernel/resources/extensions.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def list(
7070
timeout: float | httpx.Timeout | None | NotGiven = not_given,
7171
) -> SyncOffsetPagination[ExtensionListResponse]:
7272
"""
73-
List extensions owned by the caller's organization.
73+
List extensions in the resolved project.
7474
7575
Args:
7676
limit: Limit the number of extensions to return.
@@ -308,7 +308,7 @@ def list(
308308
timeout: float | httpx.Timeout | None | NotGiven = not_given,
309309
) -> AsyncPaginator[ExtensionListResponse, AsyncOffsetPagination[ExtensionListResponse]]:
310310
"""
311-
List extensions owned by the caller's organization.
311+
List extensions in the resolved project.
312312
313313
Args:
314314
limit: Limit the number of extensions to return.

src/kernel/resources/proxies.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def create(
6565
timeout: float | httpx.Timeout | None | NotGiven = not_given,
6666
) -> ProxyCreateResponse:
6767
"""
68-
Create a new proxy configuration for the caller's organization.
68+
Create a new proxy configuration in the resolved project.
6969
7070
Args:
7171
type: Proxy type to use. In terms of quality for avoiding bot-detection, from best to
@@ -117,7 +117,7 @@ def retrieve(
117117
timeout: float | httpx.Timeout | None | NotGiven = not_given,
118118
) -> ProxyRetrieveResponse:
119119
"""
120-
Retrieve a proxy belonging to the caller's organization by ID.
120+
Retrieve a proxy in the resolved project by ID.
121121
122122
Args:
123123
extra_headers: Send extra headers
@@ -151,7 +151,7 @@ def list(
151151
timeout: float | httpx.Timeout | None | NotGiven = not_given,
152152
) -> SyncOffsetPagination[ProxyListResponse]:
153153
"""
154-
List proxies owned by the caller's organization.
154+
List proxies in the resolved project.
155155
156156
Args:
157157
limit: Limit the number of proxies to return.
@@ -313,7 +313,7 @@ async def create(
313313
timeout: float | httpx.Timeout | None | NotGiven = not_given,
314314
) -> ProxyCreateResponse:
315315
"""
316-
Create a new proxy configuration for the caller's organization.
316+
Create a new proxy configuration in the resolved project.
317317
318318
Args:
319319
type: Proxy type to use. In terms of quality for avoiding bot-detection, from best to
@@ -365,7 +365,7 @@ async def retrieve(
365365
timeout: float | httpx.Timeout | None | NotGiven = not_given,
366366
) -> ProxyRetrieveResponse:
367367
"""
368-
Retrieve a proxy belonging to the caller's organization by ID.
368+
Retrieve a proxy in the resolved project by ID.
369369
370370
Args:
371371
extra_headers: Send extra headers
@@ -399,7 +399,7 @@ def list(
399399
timeout: float | httpx.Timeout | None | NotGiven = not_given,
400400
) -> AsyncPaginator[ProxyListResponse, AsyncOffsetPagination[ProxyListResponse]]:
401401
"""
402-
List proxies owned by the caller's organization.
402+
List proxies in the resolved project.
403403
404404
Args:
405405
limit: Limit the number of proxies to return.

src/kernel/types/auth/connection_create_params.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ class ConnectionCreateParams(TypedDict, total=False):
8383
proxy: Proxy
8484
"""Proxy selection.
8585
86-
Provide either id or name. The proxy must belong to the caller's org.
86+
Provide either id or name. The proxy must be in the same project as the resource
87+
referencing it.
8788
"""
8889

8990
record_session: bool
@@ -124,7 +125,7 @@ class Credential(TypedDict, total=False):
124125
class Proxy(TypedDict, total=False):
125126
"""Proxy selection.
126127
127-
Provide either id or name. The proxy must belong to the caller's org.
128+
Provide either id or name. The proxy must be in the same project as the resource referencing it.
128129
"""
129130

130131
id: str

src/kernel/types/auth/connection_login_params.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ class ConnectionLoginParams(TypedDict, total=False):
1111
proxy: Proxy
1212
"""Proxy selection.
1313
14-
Provide either id or name. The proxy must belong to the caller's org.
14+
Provide either id or name. The proxy must be in the same project as the resource
15+
referencing it.
1516
"""
1617

1718
record_session: bool
@@ -24,7 +25,7 @@ class ConnectionLoginParams(TypedDict, total=False):
2425
class Proxy(TypedDict, total=False):
2526
"""Proxy selection.
2627
27-
Provide either id or name. The proxy must belong to the caller's org.
28+
Provide either id or name. The proxy must be in the same project as the resource referencing it.
2829
"""
2930

3031
id: str

src/kernel/types/auth/connection_update_params.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ class ConnectionUpdateParams(TypedDict, total=False):
5050
proxy: Proxy
5151
"""Proxy selection.
5252
53-
Provide either id or name. The proxy must belong to the caller's org.
53+
Provide either id or name. The proxy must be in the same project as the resource
54+
referencing it.
5455
"""
5556

5657
record_session: bool
@@ -85,7 +86,7 @@ class Credential(TypedDict, total=False):
8586
class Proxy(TypedDict, total=False):
8687
"""Proxy selection.
8788
88-
Provide either id or name. The proxy must belong to the caller's org.
89+
Provide either id or name. The proxy must be in the same project as the resource referencing it.
8990
"""
9091

9192
id: str

0 commit comments

Comments
 (0)