@spec0/sdk-public-platform 1.8.1 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/index.d.ts +2 -0
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/index.js.map +1 -1
- package/dist/generated/models/EnvTargetV1.d.ts +34 -0
- package/dist/generated/models/EnvTargetV1.d.ts.map +1 -0
- package/dist/generated/models/EnvTargetV1.js +3 -0
- package/dist/generated/models/EnvTargetV1.js.map +1 -0
- package/dist/generated/models/MockItemV1.d.ts +8 -0
- package/dist/generated/models/MockItemV1.d.ts.map +1 -1
- package/dist/generated/models/RefreshMockResponseV1.d.ts +26 -0
- package/dist/generated/models/RefreshMockResponseV1.d.ts.map +1 -0
- package/dist/generated/models/RefreshMockResponseV1.js +3 -0
- package/dist/generated/models/RefreshMockResponseV1.js.map +1 -0
- package/dist/generated/services/PublicApisService.d.ts +33 -0
- package/dist/generated/services/PublicApisService.d.ts.map +1 -1
- package/dist/generated/services/PublicApisService.js +43 -0
- package/dist/generated/services/PublicApisService.js.map +1 -1
- package/dist/generated/services/PublicMocksService.d.ts +24 -0
- package/dist/generated/services/PublicMocksService.d.ts.map +1 -1
- package/dist/generated/services/PublicMocksService.js +34 -0
- package/dist/generated/services/PublicMocksService.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/index.ts +2 -0
- package/src/generated/models/EnvTargetV1.ts +38 -0
- package/src/generated/models/MockItemV1.ts +8 -0
- package/src/generated/models/RefreshMockResponseV1.ts +30 -0
- package/src/generated/services/PublicApisService.ts +48 -0
- package/src/generated/services/PublicMocksService.ts +39 -0
|
@@ -10,6 +10,7 @@ export type { AuthError } from './models/AuthError.js';
|
|
|
10
10
|
export type { CiConfigResponseV1 } from './models/CiConfigResponseV1.js';
|
|
11
11
|
export type { CreateMockRequestV1 } from './models/CreateMockRequestV1.js';
|
|
12
12
|
export type { CreateMockResponseV1 } from './models/CreateMockResponseV1.js';
|
|
13
|
+
export type { EnvTargetV1 } from './models/EnvTargetV1.js';
|
|
13
14
|
export type { GovernanceWarningV1 } from './models/GovernanceWarningV1.js';
|
|
14
15
|
export type { MockItemV1 } from './models/MockItemV1.js';
|
|
15
16
|
export type { OrgSlugPath } from './models/OrgSlugPath.js';
|
|
@@ -21,6 +22,7 @@ export type { PublicApiMetaV1 } from './models/PublicApiMetaV1.js';
|
|
|
21
22
|
export type { PublicPublishRequestV1 } from './models/PublicPublishRequestV1.js';
|
|
22
23
|
export type { PublicPublishResponseV1 } from './models/PublicPublishResponseV1.js';
|
|
23
24
|
export type { PutSpectralRulesetRequestV1 } from './models/PutSpectralRulesetRequestV1.js';
|
|
25
|
+
export type { RefreshMockResponseV1 } from './models/RefreshMockResponseV1.js';
|
|
24
26
|
export type { SpecDiffResponseV1 } from './models/SpecDiffResponseV1.js';
|
|
25
27
|
export type { SpectralRulesetResponseV1 } from './models/SpectralRulesetResponseV1.js';
|
|
26
28
|
export type { SpecVersionListItemV1 } from './models/SpecVersionListItemV1.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AACjF,YAAY,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AACnF,YAAY,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAC3F,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAEvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AACjF,YAAY,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AACnF,YAAY,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAC3F,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAEvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,kDAA8C;AAArC,uGAAA,QAAQ,OAAA;AACjB,oEAA6E;AAApE,yHAAA,iBAAiB,OAAA;AAAE,mHAAA,WAAW,OAAA;AACvC,gDAA4C;AAAnC,qGAAA,OAAO,OAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,kDAA8C;AAArC,uGAAA,QAAQ,OAAA;AACjB,oEAA6E;AAApE,yHAAA,iBAAiB,OAAA;AAAE,mHAAA,WAAW,OAAA;AACvC,gDAA4C;AAAnC,qGAAA,OAAO,OAAA;AAqChB,wEAAoE;AAA3D,yHAAA,iBAAiB,OAAA;AAC1B,oEAAgE;AAAvD,qHAAA,eAAe,OAAA;AACxB,0EAAsE;AAA7D,2HAAA,kBAAkB,OAAA;AAC3B,wEAAoE;AAA3D,yHAAA,iBAAiB,OAAA;AAC1B,gFAA4E;AAAnE,iIAAA,qBAAqB,OAAA;AAC9B,0EAAsE;AAA7D,2HAAA,kBAAkB,OAAA;AAC3B,gFAA4E;AAAnE,iIAAA,qBAAqB,OAAA;AAC9B,0EAAsE;AAA7D,2HAAA,kBAAkB,OAAA"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One environment an API is deployed to: a destination and what's live there.
|
|
3
|
+
* Carries no variables, credentials or custom metadata.
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export type EnvTargetV1 = {
|
|
7
|
+
/**
|
|
8
|
+
* The environment's name, as the organisation defined it — unique within the
|
|
9
|
+
* org, and the whole of its meaning. There is deliberately no kind or
|
|
10
|
+
* classification alongside it: that would be a second source of truth for the
|
|
11
|
+
* same fact, free to disagree with the name the org actually typed.
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
name?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Absolute and already resolved. Where an environment's URL is derived from the
|
|
17
|
+
* spec's `servers` block, templated variables are expanded before storage, so a
|
|
18
|
+
* client never has to resolve a template itself.
|
|
19
|
+
*
|
|
20
|
+
*/
|
|
21
|
+
url?: string;
|
|
22
|
+
/**
|
|
23
|
+
* The spec version live in this environment, or null if nothing has been
|
|
24
|
+
* published to or promoted into it. A client holding a different version can
|
|
25
|
+
* say so, instead of reporting the difference as contract drift.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
currentVersion?: string | null;
|
|
29
|
+
/**
|
|
30
|
+
* When this environment's configuration for the API last changed.
|
|
31
|
+
*/
|
|
32
|
+
updatedAt?: string | null;
|
|
33
|
+
};
|
|
34
|
+
//# sourceMappingURL=EnvTargetV1.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EnvTargetV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/EnvTargetV1.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EnvTargetV1.js","sourceRoot":"","sources":["../../../src/generated/models/EnvTargetV1.ts"],"names":[],"mappings":""}
|
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
export type MockItemV1 = {
|
|
2
|
+
/**
|
|
3
|
+
* The spec version this mock is currently serving. May lag the API's latest
|
|
4
|
+
* published version — a mock is bound to the snapshot it was built from
|
|
5
|
+
* until refreshed. Clients use this to distinguish version skew from real
|
|
6
|
+
* contract drift.
|
|
7
|
+
*
|
|
8
|
+
*/
|
|
9
|
+
specVersion?: string | null;
|
|
2
10
|
mockServerId?: string;
|
|
3
11
|
apiId?: string;
|
|
4
12
|
apiName?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MockItemV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/MockItemV1.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,UAAU,GAAG;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
|
|
1
|
+
{"version":3,"file":"MockItemV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/MockItemV1.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
export type RefreshMockResponseV1 = {
|
|
2
|
+
/**
|
|
3
|
+
* Unchanged by a refresh — the public handle is stable.
|
|
4
|
+
*/
|
|
5
|
+
mockServerId?: string;
|
|
6
|
+
/**
|
|
7
|
+
* The spec version the mock now serves.
|
|
8
|
+
*/
|
|
9
|
+
specVersion?: string | null;
|
|
10
|
+
/**
|
|
11
|
+
* False when the mock already served the current spec.
|
|
12
|
+
*/
|
|
13
|
+
refreshed?: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Hand-written variants re-created on the rebuilt mock.
|
|
16
|
+
*/
|
|
17
|
+
customVariantsCarriedOver?: number;
|
|
18
|
+
/**
|
|
19
|
+
* Hand-written variants that could not be carried over because their
|
|
20
|
+
* operation no longer exists in the spec. Reported rather than silently
|
|
21
|
+
* discarded.
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
customVariantsDropped?: Array<string>;
|
|
25
|
+
};
|
|
26
|
+
//# sourceMappingURL=RefreshMockResponseV1.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RefreshMockResponseV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/RefreshMockResponseV1.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RefreshMockResponseV1.js","sourceRoot":"","sources":["../../../src/generated/models/RefreshMockResponseV1.ts"],"names":[],"mappings":""}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { ApiTeamListItemV1 } from '../models/ApiTeamListItemV1.js';
|
|
2
|
+
import type { EnvTargetV1 } from '../models/EnvTargetV1.js';
|
|
2
3
|
import type { PublicApiListItem } from '../models/PublicApiListItem.js';
|
|
3
4
|
import type { PublicApiMetaV1 } from '../models/PublicApiMetaV1.js';
|
|
4
5
|
import type { PublicPublishRequestV1 } from '../models/PublicPublishRequestV1.js';
|
|
@@ -92,6 +93,38 @@ export declare class PublicApisService {
|
|
|
92
93
|
static getTeamApiSpec({ apiId, }: {
|
|
93
94
|
apiId: string;
|
|
94
95
|
}): CancelablePromise<string>;
|
|
96
|
+
/**
|
|
97
|
+
* List the environments an API is deployed to
|
|
98
|
+
* Where this API actually runs — the URLs the platform already knows, so a client
|
|
99
|
+
* doesn't have to ask a developer to type them.
|
|
100
|
+
*
|
|
101
|
+
* **Targets, not client environments.** These are destinations: an environment's
|
|
102
|
+
* name and the URL it serves at. They carry no variables, tokens or secrets, and
|
|
103
|
+
* clients must not treat them as a place to put any. Per-API custom metadata
|
|
104
|
+
* (`envMetadata` on the internal surface) is free-form and may hold credentials in
|
|
105
|
+
* existing orgs, so it is deliberately **not** returned here.
|
|
106
|
+
*
|
|
107
|
+
* Environments are whatever the organisation defined, named however they named
|
|
108
|
+
* them, and the name is the whole of their meaning. There is no classification
|
|
109
|
+
* field: this endpoint reports what exists, it does not interpret it.
|
|
110
|
+
*
|
|
111
|
+
* Returned in the organisation's promotion order — the same order the dashboard
|
|
112
|
+
* lays them out in, so the two surfaces agree.
|
|
113
|
+
*
|
|
114
|
+
* Choosing a destination is the developer's, so a client should present these and
|
|
115
|
+
* let one be picked rather than picking on their behalf.
|
|
116
|
+
*
|
|
117
|
+
* Authorization stack:
|
|
118
|
+
* - scope: `read:apis`
|
|
119
|
+
* - ABAC v2: caller must be permitted to `view` the API resource (cross-org and
|
|
120
|
+
* cross-team isolation collapse to 404 to avoid leaking existence).
|
|
121
|
+
*
|
|
122
|
+
* @returns EnvTargetV1 Environments configured for this API, in the org's promotion order
|
|
123
|
+
* @throws ApiError
|
|
124
|
+
*/
|
|
125
|
+
static listTeamApiEnvironments({ apiId, }: {
|
|
126
|
+
apiId: string;
|
|
127
|
+
}): CancelablePromise<Array<EnvTargetV1>>;
|
|
95
128
|
/**
|
|
96
129
|
* List published versions of a team-scoped private API
|
|
97
130
|
* Mirrors `GET /api/v1/public/registry/{orgSlug}/{apiName}/versions` for the
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicApisService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,iBAAiB;IAC5B;;;;;OAKG;WACW,cAAc,IAAI,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAU3E;;;;;;;;OAQG;WACW,gBAAgB,CAAC,EAC7B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,sBAAsB,CAAC;KACrC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAe9C;;;;;;;;;;OAUG;WACW,YAAY,IAAI,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAUzE;;;;;;;;;;;;;OAaG;WACW,cAAc,CAAC,EAC3B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,oBAAoB,CAAC;KACnC,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAgB5C;;;;;;;;;;;OAWG;WACW,aAAa,CAAC,EAC1B,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,IAAI,CAAC;IAc3B;;;;;;;;;;;;;;;;OAgBG;WACW,cAAc,CAAC,EAC3B,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAc7B;;;;;;;;;OASG;WACW,mBAAmB,CAAC,EAChC,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAcnD;;;;;;;;OAQG;WACW,mBAAmB,CAAC,EAChC,KAAK,EACL,GAAG,GACJ,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAe7B;;;;;;;;;OASG;WACW,yBAAyB,CAAC,EACtC,WAAW,EACX,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,yBAAyB,CAAC;KACxC,GAAG,iBAAiB,CAAC,eAAe,CAAC;IAgBtC;;;;;;;OAOG;WACW,eAAe,CAAC,EAC5B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,iBAAiB,CAAC,IAAI,CAAC;CAc5B"}
|
|
1
|
+
{"version":3,"file":"PublicApisService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,iBAAiB;IAC5B;;;;;OAKG;WACW,cAAc,IAAI,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAU3E;;;;;;;;OAQG;WACW,gBAAgB,CAAC,EAC7B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,sBAAsB,CAAC;KACrC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAe9C;;;;;;;;;;OAUG;WACW,YAAY,IAAI,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAUzE;;;;;;;;;;;;;OAaG;WACW,cAAc,CAAC,EAC3B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,oBAAoB,CAAC;KACnC,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAgB5C;;;;;;;;;;;OAWG;WACW,aAAa,CAAC,EAC1B,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,IAAI,CAAC;IAc3B;;;;;;;;;;;;;;;;OAgBG;WACW,cAAc,CAAC,EAC3B,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAc7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACW,uBAAuB,CAAC,EACpC,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAczC;;;;;;;;;OASG;WACW,mBAAmB,CAAC,EAChC,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAcnD;;;;;;;;OAQG;WACW,mBAAmB,CAAC,EAChC,KAAK,EACL,GAAG,GACJ,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAe7B;;;;;;;;;OASG;WACW,yBAAyB,CAAC,EACtC,WAAW,EACX,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,yBAAyB,CAAC;KACxC,GAAG,iBAAiB,CAAC,eAAe,CAAC;IAgBtC;;;;;;;OAOG;WACW,eAAe,CAAC,EAC5B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,iBAAiB,CAAC,IAAI,CAAC;CAc5B"}
|
|
@@ -152,6 +152,49 @@ class PublicApisService {
|
|
|
152
152
|
},
|
|
153
153
|
});
|
|
154
154
|
}
|
|
155
|
+
/**
|
|
156
|
+
* List the environments an API is deployed to
|
|
157
|
+
* Where this API actually runs — the URLs the platform already knows, so a client
|
|
158
|
+
* doesn't have to ask a developer to type them.
|
|
159
|
+
*
|
|
160
|
+
* **Targets, not client environments.** These are destinations: an environment's
|
|
161
|
+
* name and the URL it serves at. They carry no variables, tokens or secrets, and
|
|
162
|
+
* clients must not treat them as a place to put any. Per-API custom metadata
|
|
163
|
+
* (`envMetadata` on the internal surface) is free-form and may hold credentials in
|
|
164
|
+
* existing orgs, so it is deliberately **not** returned here.
|
|
165
|
+
*
|
|
166
|
+
* Environments are whatever the organisation defined, named however they named
|
|
167
|
+
* them, and the name is the whole of their meaning. There is no classification
|
|
168
|
+
* field: this endpoint reports what exists, it does not interpret it.
|
|
169
|
+
*
|
|
170
|
+
* Returned in the organisation's promotion order — the same order the dashboard
|
|
171
|
+
* lays them out in, so the two surfaces agree.
|
|
172
|
+
*
|
|
173
|
+
* Choosing a destination is the developer's, so a client should present these and
|
|
174
|
+
* let one be picked rather than picking on their behalf.
|
|
175
|
+
*
|
|
176
|
+
* Authorization stack:
|
|
177
|
+
* - scope: `read:apis`
|
|
178
|
+
* - ABAC v2: caller must be permitted to `view` the API resource (cross-org and
|
|
179
|
+
* cross-team isolation collapse to 404 to avoid leaking existence).
|
|
180
|
+
*
|
|
181
|
+
* @returns EnvTargetV1 Environments configured for this API, in the org's promotion order
|
|
182
|
+
* @throws ApiError
|
|
183
|
+
*/
|
|
184
|
+
static listTeamApiEnvironments({ apiId, }) {
|
|
185
|
+
return (0, request_js_1.request)(OpenAPI_js_1.OpenAPI, {
|
|
186
|
+
method: 'GET',
|
|
187
|
+
url: '/api/v1/public/apis/team/{apiId}/environments',
|
|
188
|
+
path: {
|
|
189
|
+
'apiId': apiId,
|
|
190
|
+
},
|
|
191
|
+
errors: {
|
|
192
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
193
|
+
403: `Token does not carry the required scope`,
|
|
194
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
195
|
+
},
|
|
196
|
+
});
|
|
197
|
+
}
|
|
155
198
|
/**
|
|
156
199
|
* List published versions of a team-scoped private API
|
|
157
200
|
* Mirrors `GET /api/v1/public/registry/{orgSlug}/{apiName}/versions` for the
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicApisService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"PublicApisService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":";;;AAeA,mDAA6C;AAC7C,mDAA0D;AAC1D,MAAa,iBAAiB;IAC5B;;;;;OAKG;IACI,MAAM,CAAC,cAAc;QAC1B,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,qBAAqB;YAC1B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,gBAAgB,CAAC,EAC7B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,qBAAqB;YAC1B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,0EAA0E;gBAC/E,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;OAUG;IACI,MAAM,CAAC,YAAY;QACxB,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,0BAA0B;YAC/B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,cAAc,CAAC,EAC3B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,0BAA0B;YAC/B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;gBAC7D,GAAG,EAAE,oGAAoG;gBACzG,GAAG,EAAE,kDAAkD;aACxD;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,aAAa,CAAC,EAC1B,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,kCAAkC;YACvC,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACI,MAAM,CAAC,cAAc,CAAC,EAC3B,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,uCAAuC;YAC5C,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,MAAM,CAAC,uBAAuB,CAAC,EACpC,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,+CAA+C;YACpD,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;OASG;IACI,MAAM,CAAC,mBAAmB,CAAC,EAChC,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,2CAA2C;YAChD,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,mBAAmB,CAAC,EAChC,KAAK,EACL,GAAG,GAIJ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iDAAiD;YACtD,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,GAAG;aACX;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;OASG;IACI,MAAM,CAAC,yBAAyB,CAAC,EACtC,WAAW,EACX,WAAW,GAIZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,8CAA8C;YACnD,IAAI,EAAE;gBACJ,aAAa,EAAE,WAAW;aAC3B;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,eAAe,CAAC,EAC5B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,mCAAmC;YACxC,IAAI,EAAE;gBACJ,aAAa,EAAE,WAAW;aAC3B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAxUD,8CAwUC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { CreateMockRequestV1 } from '../models/CreateMockRequestV1.js';
|
|
2
2
|
import type { CreateMockResponseV1 } from '../models/CreateMockResponseV1.js';
|
|
3
3
|
import type { MockItemV1 } from '../models/MockItemV1.js';
|
|
4
|
+
import type { RefreshMockResponseV1 } from '../models/RefreshMockResponseV1.js';
|
|
4
5
|
import type { CancelablePromise } from '../core/CancelablePromise.js';
|
|
5
6
|
export declare class PublicMocksService {
|
|
6
7
|
/**
|
|
@@ -25,6 +26,29 @@ export declare class PublicMocksService {
|
|
|
25
26
|
static createPublicMock({ requestBody, }: {
|
|
26
27
|
requestBody: CreateMockRequestV1;
|
|
27
28
|
}): CancelablePromise<CreateMockResponseV1>;
|
|
29
|
+
/**
|
|
30
|
+
* Re-provision a mock against its API's latest published spec
|
|
31
|
+
* A mock is bound to the spec snapshot it was created from, so publishing a new
|
|
32
|
+
* version of an API leaves its mock serving the previous contract. This rebuilds
|
|
33
|
+
* it against the API's current spec.
|
|
34
|
+
*
|
|
35
|
+
* The mock's **public id, URL and API key are unchanged** — those are what CI
|
|
36
|
+
* configs and clients already hold. Auto-generated variants are replaced with
|
|
37
|
+
* ones correct for the new spec; hand-written variants are carried over where
|
|
38
|
+
* their operation still exists, and the ones that couldn't be are listed in the
|
|
39
|
+
* response rather than silently dropped.
|
|
40
|
+
*
|
|
41
|
+
* Idempotent: refreshing a mock that already serves the current spec reports
|
|
42
|
+
* `refreshed: false` and changes nothing.
|
|
43
|
+
*
|
|
44
|
+
* Cross-org returns 404, not 403, so the existence of a mock is not leaked.
|
|
45
|
+
*
|
|
46
|
+
* @returns RefreshMockResponseV1 Refresh outcome
|
|
47
|
+
* @throws ApiError
|
|
48
|
+
*/
|
|
49
|
+
static refreshPublicMock({ mockServerId, }: {
|
|
50
|
+
mockServerId: string;
|
|
51
|
+
}): CancelablePromise<RefreshMockResponseV1>;
|
|
28
52
|
/**
|
|
29
53
|
* Delete a mock server owned by the calling org
|
|
30
54
|
* Hard-deletes the mock server and removes its association with the parent API.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicMocksService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,kBAAkB;IAC7B;;;;;;;;;OASG;WACW,eAAe,IAAI,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAUrE;;;;;;;OAOG;WACW,gBAAgB,CAAC,EAC7B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,mBAAmB,CAAC;KAClC,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;IAc3C;;;;;;;;OAQG;WACW,gBAAgB,CAAC,EAC7B,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAC;KACtB,GAAG,iBAAiB,CAAC,IAAI,CAAC;CAc5B"}
|
|
1
|
+
{"version":3,"file":"PublicMocksService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,kBAAkB;IAC7B;;;;;;;;;OASG;WACW,eAAe,IAAI,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAUrE;;;;;;;OAOG;WACW,gBAAgB,CAAC,EAC7B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,mBAAmB,CAAC;KAClC,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;IAc3C;;;;;;;;;;;;;;;;;;;OAmBG;WACW,iBAAiB,CAAC,EAC9B,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAC;KACtB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAc5C;;;;;;;;OAQG;WACW,gBAAgB,CAAC,EAC7B,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAC;KACtB,GAAG,iBAAiB,CAAC,IAAI,CAAC;CAc5B"}
|
|
@@ -46,6 +46,40 @@ class PublicMocksService {
|
|
|
46
46
|
},
|
|
47
47
|
});
|
|
48
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* Re-provision a mock against its API's latest published spec
|
|
51
|
+
* A mock is bound to the spec snapshot it was created from, so publishing a new
|
|
52
|
+
* version of an API leaves its mock serving the previous contract. This rebuilds
|
|
53
|
+
* it against the API's current spec.
|
|
54
|
+
*
|
|
55
|
+
* The mock's **public id, URL and API key are unchanged** — those are what CI
|
|
56
|
+
* configs and clients already hold. Auto-generated variants are replaced with
|
|
57
|
+
* ones correct for the new spec; hand-written variants are carried over where
|
|
58
|
+
* their operation still exists, and the ones that couldn't be are listed in the
|
|
59
|
+
* response rather than silently dropped.
|
|
60
|
+
*
|
|
61
|
+
* Idempotent: refreshing a mock that already serves the current spec reports
|
|
62
|
+
* `refreshed: false` and changes nothing.
|
|
63
|
+
*
|
|
64
|
+
* Cross-org returns 404, not 403, so the existence of a mock is not leaked.
|
|
65
|
+
*
|
|
66
|
+
* @returns RefreshMockResponseV1 Refresh outcome
|
|
67
|
+
* @throws ApiError
|
|
68
|
+
*/
|
|
69
|
+
static refreshPublicMock({ mockServerId, }) {
|
|
70
|
+
return (0, request_js_1.request)(OpenAPI_js_1.OpenAPI, {
|
|
71
|
+
method: 'POST',
|
|
72
|
+
url: '/api/v1/public/mocks/{mockServerId}/refresh',
|
|
73
|
+
path: {
|
|
74
|
+
'mockServerId': mockServerId,
|
|
75
|
+
},
|
|
76
|
+
errors: {
|
|
77
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
78
|
+
403: `Token does not carry the required scope`,
|
|
79
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
80
|
+
},
|
|
81
|
+
});
|
|
82
|
+
}
|
|
49
83
|
/**
|
|
50
84
|
* Delete a mock server owned by the calling org
|
|
51
85
|
* Hard-deletes the mock server and removes its association with the parent API.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicMocksService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"PublicMocksService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":";;;AASA,mDAA6C;AAC7C,mDAA0D;AAC1D,MAAa,kBAAkB;IAC7B;;;;;;;;;OASG;IACI,MAAM,CAAC,eAAe;QAC3B,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,sBAAsB;YAC3B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,gBAAgB,CAAC,EAC7B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,sBAAsB;YAC3B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACI,MAAM,CAAC,iBAAiB,CAAC,EAC9B,YAAY,GAGb;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,6CAA6C;YAClD,IAAI,EAAE;gBACJ,cAAc,EAAE,YAAY;aAC7B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,gBAAgB,CAAC,EAC7B,YAAY,GAGb;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,qCAAqC;YAC1C,IAAI,EAAE;gBACJ,cAAc,EAAE,YAAY;aAC7B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAhHD,gDAgHC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spec0/sdk-public-platform",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.10.0",
|
|
4
4
|
"description": "TypeScript SDK for Spec0's public API surface (https://app.spec0.io). Generated from the OpenAPI spec published at spec0/spec0-platform.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "./dist/index.js",
|
package/src/generated/index.ts
CHANGED
|
@@ -15,6 +15,7 @@ export type { AuthError } from './models/AuthError.js';
|
|
|
15
15
|
export type { CiConfigResponseV1 } from './models/CiConfigResponseV1.js';
|
|
16
16
|
export type { CreateMockRequestV1 } from './models/CreateMockRequestV1.js';
|
|
17
17
|
export type { CreateMockResponseV1 } from './models/CreateMockResponseV1.js';
|
|
18
|
+
export type { EnvTargetV1 } from './models/EnvTargetV1.js';
|
|
18
19
|
export type { GovernanceWarningV1 } from './models/GovernanceWarningV1.js';
|
|
19
20
|
export type { MockItemV1 } from './models/MockItemV1.js';
|
|
20
21
|
export type { OrgSlugPath } from './models/OrgSlugPath.js';
|
|
@@ -26,6 +27,7 @@ export type { PublicApiMetaV1 } from './models/PublicApiMetaV1.js';
|
|
|
26
27
|
export type { PublicPublishRequestV1 } from './models/PublicPublishRequestV1.js';
|
|
27
28
|
export type { PublicPublishResponseV1 } from './models/PublicPublishResponseV1.js';
|
|
28
29
|
export type { PutSpectralRulesetRequestV1 } from './models/PutSpectralRulesetRequestV1.js';
|
|
30
|
+
export type { RefreshMockResponseV1 } from './models/RefreshMockResponseV1.js';
|
|
29
31
|
export type { SpecDiffResponseV1 } from './models/SpecDiffResponseV1.js';
|
|
30
32
|
export type { SpectralRulesetResponseV1 } from './models/SpectralRulesetResponseV1.js';
|
|
31
33
|
export type { SpecVersionListItemV1 } from './models/SpecVersionListItemV1.js';
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
/**
|
|
6
|
+
* One environment an API is deployed to: a destination and what's live there.
|
|
7
|
+
* Carries no variables, credentials or custom metadata.
|
|
8
|
+
*
|
|
9
|
+
*/
|
|
10
|
+
export type EnvTargetV1 = {
|
|
11
|
+
/**
|
|
12
|
+
* The environment's name, as the organisation defined it — unique within the
|
|
13
|
+
* org, and the whole of its meaning. There is deliberately no kind or
|
|
14
|
+
* classification alongside it: that would be a second source of truth for the
|
|
15
|
+
* same fact, free to disagree with the name the org actually typed.
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
name?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Absolute and already resolved. Where an environment's URL is derived from the
|
|
21
|
+
* spec's `servers` block, templated variables are expanded before storage, so a
|
|
22
|
+
* client never has to resolve a template itself.
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
url?: string;
|
|
26
|
+
/**
|
|
27
|
+
* The spec version live in this environment, or null if nothing has been
|
|
28
|
+
* published to or promoted into it. A client holding a different version can
|
|
29
|
+
* say so, instead of reporting the difference as contract drift.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
currentVersion?: string | null;
|
|
33
|
+
/**
|
|
34
|
+
* When this environment's configuration for the API last changed.
|
|
35
|
+
*/
|
|
36
|
+
updatedAt?: string | null;
|
|
37
|
+
};
|
|
38
|
+
|
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
export type MockItemV1 = {
|
|
6
|
+
/**
|
|
7
|
+
* The spec version this mock is currently serving. May lag the API's latest
|
|
8
|
+
* published version — a mock is bound to the snapshot it was built from
|
|
9
|
+
* until refreshed. Clients use this to distinguish version skew from real
|
|
10
|
+
* contract drift.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
specVersion?: string | null;
|
|
6
14
|
mockServerId?: string;
|
|
7
15
|
apiId?: string;
|
|
8
16
|
apiName?: string;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
export type RefreshMockResponseV1 = {
|
|
6
|
+
/**
|
|
7
|
+
* Unchanged by a refresh — the public handle is stable.
|
|
8
|
+
*/
|
|
9
|
+
mockServerId?: string;
|
|
10
|
+
/**
|
|
11
|
+
* The spec version the mock now serves.
|
|
12
|
+
*/
|
|
13
|
+
specVersion?: string | null;
|
|
14
|
+
/**
|
|
15
|
+
* False when the mock already served the current spec.
|
|
16
|
+
*/
|
|
17
|
+
refreshed?: boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Hand-written variants re-created on the rebuilt mock.
|
|
20
|
+
*/
|
|
21
|
+
customVariantsCarriedOver?: number;
|
|
22
|
+
/**
|
|
23
|
+
* Hand-written variants that could not be carried over because their
|
|
24
|
+
* operation no longer exists in the spec. Reported rather than silently
|
|
25
|
+
* discarded.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
customVariantsDropped?: Array<string>;
|
|
29
|
+
};
|
|
30
|
+
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
import type { ApiTeamListItemV1 } from '../models/ApiTeamListItemV1.js';
|
|
6
|
+
import type { EnvTargetV1 } from '../models/EnvTargetV1.js';
|
|
6
7
|
import type { PublicApiListItem } from '../models/PublicApiListItem.js';
|
|
7
8
|
import type { PublicApiMetaV1 } from '../models/PublicApiMetaV1.js';
|
|
8
9
|
import type { PublicPublishRequestV1 } from '../models/PublicPublishRequestV1.js';
|
|
@@ -179,6 +180,53 @@ export class PublicApisService {
|
|
|
179
180
|
},
|
|
180
181
|
});
|
|
181
182
|
}
|
|
183
|
+
/**
|
|
184
|
+
* List the environments an API is deployed to
|
|
185
|
+
* Where this API actually runs — the URLs the platform already knows, so a client
|
|
186
|
+
* doesn't have to ask a developer to type them.
|
|
187
|
+
*
|
|
188
|
+
* **Targets, not client environments.** These are destinations: an environment's
|
|
189
|
+
* name and the URL it serves at. They carry no variables, tokens or secrets, and
|
|
190
|
+
* clients must not treat them as a place to put any. Per-API custom metadata
|
|
191
|
+
* (`envMetadata` on the internal surface) is free-form and may hold credentials in
|
|
192
|
+
* existing orgs, so it is deliberately **not** returned here.
|
|
193
|
+
*
|
|
194
|
+
* Environments are whatever the organisation defined, named however they named
|
|
195
|
+
* them, and the name is the whole of their meaning. There is no classification
|
|
196
|
+
* field: this endpoint reports what exists, it does not interpret it.
|
|
197
|
+
*
|
|
198
|
+
* Returned in the organisation's promotion order — the same order the dashboard
|
|
199
|
+
* lays them out in, so the two surfaces agree.
|
|
200
|
+
*
|
|
201
|
+
* Choosing a destination is the developer's, so a client should present these and
|
|
202
|
+
* let one be picked rather than picking on their behalf.
|
|
203
|
+
*
|
|
204
|
+
* Authorization stack:
|
|
205
|
+
* - scope: `read:apis`
|
|
206
|
+
* - ABAC v2: caller must be permitted to `view` the API resource (cross-org and
|
|
207
|
+
* cross-team isolation collapse to 404 to avoid leaking existence).
|
|
208
|
+
*
|
|
209
|
+
* @returns EnvTargetV1 Environments configured for this API, in the org's promotion order
|
|
210
|
+
* @throws ApiError
|
|
211
|
+
*/
|
|
212
|
+
public static listTeamApiEnvironments({
|
|
213
|
+
apiId,
|
|
214
|
+
}: {
|
|
215
|
+
apiId: string,
|
|
216
|
+
}): CancelablePromise<Array<EnvTargetV1>> {
|
|
217
|
+
return __request(OpenAPI, {
|
|
218
|
+
method: 'GET',
|
|
219
|
+
url: '/api/v1/public/apis/team/{apiId}/environments',
|
|
220
|
+
path: {
|
|
221
|
+
'apiId': apiId,
|
|
222
|
+
},
|
|
223
|
+
errors: {
|
|
224
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
225
|
+
403: `Token does not carry the required scope`,
|
|
226
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
227
|
+
},
|
|
228
|
+
});
|
|
229
|
+
}
|
|
182
230
|
/**
|
|
183
231
|
* List published versions of a team-scoped private API
|
|
184
232
|
* Mirrors `GET /api/v1/public/registry/{orgSlug}/{apiName}/versions` for the
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
import type { CreateMockRequestV1 } from '../models/CreateMockRequestV1.js';
|
|
6
6
|
import type { CreateMockResponseV1 } from '../models/CreateMockResponseV1.js';
|
|
7
7
|
import type { MockItemV1 } from '../models/MockItemV1.js';
|
|
8
|
+
import type { RefreshMockResponseV1 } from '../models/RefreshMockResponseV1.js';
|
|
8
9
|
import type { CancelablePromise } from '../core/CancelablePromise.js';
|
|
9
10
|
import { OpenAPI } from '../core/OpenAPI.js';
|
|
10
11
|
import { request as __request } from '../core/request.js';
|
|
@@ -55,6 +56,44 @@ export class PublicMocksService {
|
|
|
55
56
|
},
|
|
56
57
|
});
|
|
57
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
* Re-provision a mock against its API's latest published spec
|
|
61
|
+
* A mock is bound to the spec snapshot it was created from, so publishing a new
|
|
62
|
+
* version of an API leaves its mock serving the previous contract. This rebuilds
|
|
63
|
+
* it against the API's current spec.
|
|
64
|
+
*
|
|
65
|
+
* The mock's **public id, URL and API key are unchanged** — those are what CI
|
|
66
|
+
* configs and clients already hold. Auto-generated variants are replaced with
|
|
67
|
+
* ones correct for the new spec; hand-written variants are carried over where
|
|
68
|
+
* their operation still exists, and the ones that couldn't be are listed in the
|
|
69
|
+
* response rather than silently dropped.
|
|
70
|
+
*
|
|
71
|
+
* Idempotent: refreshing a mock that already serves the current spec reports
|
|
72
|
+
* `refreshed: false` and changes nothing.
|
|
73
|
+
*
|
|
74
|
+
* Cross-org returns 404, not 403, so the existence of a mock is not leaked.
|
|
75
|
+
*
|
|
76
|
+
* @returns RefreshMockResponseV1 Refresh outcome
|
|
77
|
+
* @throws ApiError
|
|
78
|
+
*/
|
|
79
|
+
public static refreshPublicMock({
|
|
80
|
+
mockServerId,
|
|
81
|
+
}: {
|
|
82
|
+
mockServerId: string,
|
|
83
|
+
}): CancelablePromise<RefreshMockResponseV1> {
|
|
84
|
+
return __request(OpenAPI, {
|
|
85
|
+
method: 'POST',
|
|
86
|
+
url: '/api/v1/public/mocks/{mockServerId}/refresh',
|
|
87
|
+
path: {
|
|
88
|
+
'mockServerId': mockServerId,
|
|
89
|
+
},
|
|
90
|
+
errors: {
|
|
91
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
92
|
+
403: `Token does not carry the required scope`,
|
|
93
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
94
|
+
},
|
|
95
|
+
});
|
|
96
|
+
}
|
|
58
97
|
/**
|
|
59
98
|
* Delete a mock server owned by the calling org
|
|
60
99
|
* Hard-deletes the mock server and removes its association with the parent API.
|