Skip to content

Commit 5a9b47d

Browse files
docs(api): correct project-scoping descriptions in OpenAPI spec
1 parent 52a0847 commit 5a9b47d

7 files changed

Lines changed: 36 additions & 37 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: 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/resources/auth/connections.ts

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -699,8 +699,8 @@ export interface ManagedAuthCreateRequest {
699699
login_url?: string;
700700

701701
/**
702-
* Proxy selection. Provide either id or name. The proxy must belong to the
703-
* caller's org.
702+
* Proxy selection. Provide either id or name. The proxy must be in the same
703+
* project as the resource referencing it.
704704
*/
705705
proxy?: ManagedAuthCreateRequest.Proxy;
706706

@@ -748,8 +748,8 @@ export namespace ManagedAuthCreateRequest {
748748
}
749749

750750
/**
751-
* Proxy selection. Provide either id or name. The proxy must belong to the
752-
* caller's org.
751+
* Proxy selection. Provide either id or name. The proxy must be in the same
752+
* project as the resource referencing it.
753753
*/
754754
export interface Proxy {
755755
/**
@@ -812,8 +812,8 @@ export interface ManagedAuthUpdateRequest {
812812
login_url?: string;
813813

814814
/**
815-
* Proxy selection. Provide either id or name. The proxy must belong to the
816-
* caller's org.
815+
* Proxy selection. Provide either id or name. The proxy must be in the same
816+
* project as the resource referencing it.
817817
*/
818818
proxy?: ManagedAuthUpdateRequest.Proxy;
819819

@@ -859,8 +859,8 @@ export namespace ManagedAuthUpdateRequest {
859859
}
860860

861861
/**
862-
* Proxy selection. Provide either id or name. The proxy must belong to the
863-
* caller's org.
862+
* Proxy selection. Provide either id or name. The proxy must be in the same
863+
* project as the resource referencing it.
864864
*/
865865
export interface Proxy {
866866
/**
@@ -1215,8 +1215,8 @@ export interface ConnectionCreateParams {
12151215
login_url?: string;
12161216

12171217
/**
1218-
* Proxy selection. Provide either id or name. The proxy must belong to the
1219-
* caller's org.
1218+
* Proxy selection. Provide either id or name. The proxy must be in the same
1219+
* project as the resource referencing it.
12201220
*/
12211221
proxy?: ConnectionCreateParams.Proxy;
12221222

@@ -1264,8 +1264,8 @@ export namespace ConnectionCreateParams {
12641264
}
12651265

12661266
/**
1267-
* Proxy selection. Provide either id or name. The proxy must belong to the
1268-
* caller's org.
1267+
* Proxy selection. Provide either id or name. The proxy must be in the same
1268+
* project as the resource referencing it.
12691269
*/
12701270
export interface Proxy {
12711271
/**
@@ -1325,8 +1325,8 @@ export interface ConnectionUpdateParams {
13251325
login_url?: string;
13261326

13271327
/**
1328-
* Proxy selection. Provide either id or name. The proxy must belong to the
1329-
* caller's org.
1328+
* Proxy selection. Provide either id or name. The proxy must be in the same
1329+
* project as the resource referencing it.
13301330
*/
13311331
proxy?: ConnectionUpdateParams.Proxy;
13321332

@@ -1372,8 +1372,8 @@ export namespace ConnectionUpdateParams {
13721372
}
13731373

13741374
/**
1375-
* Proxy selection. Provide either id or name. The proxy must belong to the
1376-
* caller's org.
1375+
* Proxy selection. Provide either id or name. The proxy must be in the same
1376+
* project as the resource referencing it.
13771377
*/
13781378
export interface Proxy {
13791379
/**
@@ -1402,8 +1402,8 @@ export interface ConnectionListParams extends OffsetPaginationParams {
14021402

14031403
export interface ConnectionLoginParams {
14041404
/**
1405-
* Proxy selection. Provide either id or name. The proxy must belong to the
1406-
* caller's org.
1405+
* Proxy selection. Provide either id or name. The proxy must be in the same
1406+
* project as the resource referencing it.
14071407
*/
14081408
proxy?: ConnectionLoginParams.Proxy;
14091409

@@ -1416,8 +1416,8 @@ export interface ConnectionLoginParams {
14161416

14171417
export namespace ConnectionLoginParams {
14181418
/**
1419-
* Proxy selection. Provide either id or name. The proxy must belong to the
1420-
* caller's org.
1419+
* Proxy selection. Provide either id or name. The proxy must be in the same
1420+
* project as the resource referencing it.
14211421
*/
14221422
export interface Proxy {
14231423
/**

src/resources/browser-pools.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export class BrowserPools extends APIResource {
5757
}
5858

5959
/**
60-
* List browser pools owned by the caller's organization.
60+
* List browser pools in the resolved project.
6161
*
6262
* @example
6363
* ```ts
@@ -241,8 +241,8 @@ export namespace BrowserPool {
241241
profile?: Shared.BrowserProfile;
242242

243243
/**
244-
* Optional proxy to associate to the browser session. Must reference a proxy
245-
* belonging to the caller's org.
244+
* Optional proxy to associate to the browser session. Must reference a proxy in
245+
* the same project as the browser session.
246246
*/
247247
proxy_id?: string;
248248

@@ -467,8 +467,8 @@ export interface BrowserPoolCreateParams {
467467
profile?: Shared.BrowserProfile;
468468

469469
/**
470-
* Optional proxy to associate to the browser session. Must reference a proxy
471-
* belonging to the caller's org.
470+
* Optional proxy to associate to the browser session. Must reference a proxy in
471+
* the same project as the browser session.
472472
*/
473473
proxy_id?: string;
474474

@@ -559,8 +559,8 @@ export interface BrowserPoolUpdateParams {
559559
profile?: Shared.BrowserProfile;
560560

561561
/**
562-
* Optional proxy to associate to the browser session. Must reference a proxy
563-
* belonging to the caller's org.
562+
* Optional proxy to associate to the browser session. Must reference a proxy in
563+
* the same project as the browser session.
564564
*/
565565
proxy_id?: string;
566566

src/resources/browsers/browsers.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -941,8 +941,8 @@ export interface BrowserCreateParams {
941941
profile?: Shared.BrowserProfile;
942942

943943
/**
944-
* Optional proxy to associate to the browser session. Must reference a proxy
945-
* belonging to the caller's org.
944+
* Optional proxy to associate to the browser session. Must reference a proxy in
945+
* the same project as the browser session.
946946
*/
947947
proxy_id?: string;
948948

src/resources/credentials.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ export class Credentials extends APIResource {
6060
}
6161

6262
/**
63-
* List credentials owned by the caller's organization. Credential values are not
64-
* returned.
63+
* List credentials in the resolved project. Credential values are not returned.
6564
*
6665
* @example
6766
* ```ts

src/resources/extensions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
1414
*/
1515
export class Extensions extends APIResource {
1616
/**
17-
* List extensions owned by the caller's organization.
17+
* List extensions in the resolved project.
1818
*
1919
* @example
2020
* ```ts

src/resources/proxies.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ import { path } from '../internal/utils/path';
1212
*/
1313
export class Proxies extends APIResource {
1414
/**
15-
* Create a new proxy configuration for the caller's organization.
15+
* Create a new proxy configuration in the resolved project.
1616
*/
1717
create(body: ProxyCreateParams, options?: RequestOptions): APIPromise<ProxyCreateResponse> {
1818
return this._client.post('/proxies', { body, ...options });
1919
}
2020

2121
/**
22-
* Retrieve a proxy belonging to the caller's organization by ID.
22+
* Retrieve a proxy in the resolved project by ID.
2323
*/
2424
retrieve(id: string, options?: RequestOptions): APIPromise<ProxyRetrieveResponse> {
2525
return this._client.get(path`/proxies/${id}`, options);
2626
}
2727

2828
/**
29-
* List proxies owned by the caller's organization.
29+
* List proxies in the resolved project.
3030
*/
3131
list(
3232
query: ProxyListParams | null | undefined = {},

0 commit comments

Comments
 (0)