@spec0/sdk-public-platform 1.1.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/README.md +48 -0
- package/dist/generated/core/ApiError.d.ts +11 -0
- package/dist/generated/core/ApiError.d.ts.map +1 -0
- package/dist/generated/core/ApiError.js +17 -0
- package/dist/generated/core/ApiError.js.map +1 -0
- package/dist/generated/core/ApiRequestOptions.d.ts +14 -0
- package/dist/generated/core/ApiRequestOptions.d.ts.map +1 -0
- package/dist/generated/core/ApiRequestOptions.js +2 -0
- package/dist/generated/core/ApiRequestOptions.js.map +1 -0
- package/dist/generated/core/ApiResult.d.ts +8 -0
- package/dist/generated/core/ApiResult.d.ts.map +1 -0
- package/dist/generated/core/ApiResult.js +2 -0
- package/dist/generated/core/ApiResult.js.map +1 -0
- package/dist/generated/core/CancelablePromise.d.ts +21 -0
- package/dist/generated/core/CancelablePromise.d.ts.map +1 -0
- package/dist/generated/core/CancelablePromise.js +100 -0
- package/dist/generated/core/CancelablePromise.js.map +1 -0
- package/dist/generated/core/OpenAPI.d.ts +17 -0
- package/dist/generated/core/OpenAPI.d.ts.map +1 -0
- package/dist/generated/core/OpenAPI.js +12 -0
- package/dist/generated/core/OpenAPI.js.map +1 -0
- package/dist/generated/core/request.d.ts +31 -0
- package/dist/generated/core/request.d.ts.map +1 -0
- package/dist/generated/core/request.js +276 -0
- package/dist/generated/core/request.js.map +1 -0
- package/dist/generated/index.d.ts +33 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/index.js +13 -0
- package/dist/generated/index.js.map +1 -0
- package/dist/generated/models/AiSearchRequestV1.d.ts +5 -0
- package/dist/generated/models/AiSearchRequestV1.d.ts.map +1 -0
- package/dist/generated/models/AiSearchRequestV1.js +2 -0
- package/dist/generated/models/AiSearchRequestV1.js.map +1 -0
- package/dist/generated/models/AiSearchResponseV1.d.ts +4 -0
- package/dist/generated/models/AiSearchResponseV1.d.ts.map +1 -0
- package/dist/generated/models/AiSearchResponseV1.js +2 -0
- package/dist/generated/models/AiSearchResponseV1.js.map +1 -0
- package/dist/generated/models/ApiNamePath.d.ts +2 -0
- package/dist/generated/models/ApiNamePath.d.ts.map +1 -0
- package/dist/generated/models/ApiNamePath.js +2 -0
- package/dist/generated/models/ApiNamePath.js.map +1 -0
- package/dist/generated/models/AuthError.d.ts +8 -0
- package/dist/generated/models/AuthError.d.ts.map +1 -0
- package/dist/generated/models/AuthError.js +2 -0
- package/dist/generated/models/AuthError.js.map +1 -0
- package/dist/generated/models/CreateMockRequestV1.d.ts +8 -0
- package/dist/generated/models/CreateMockRequestV1.d.ts.map +1 -0
- package/dist/generated/models/CreateMockRequestV1.js +2 -0
- package/dist/generated/models/CreateMockRequestV1.js.map +1 -0
- package/dist/generated/models/CreateMockResponseV1.d.ts +11 -0
- package/dist/generated/models/CreateMockResponseV1.d.ts.map +1 -0
- package/dist/generated/models/CreateMockResponseV1.js +2 -0
- package/dist/generated/models/CreateMockResponseV1.js.map +1 -0
- package/dist/generated/models/MockItemV1.d.ts +8 -0
- package/dist/generated/models/MockItemV1.d.ts.map +1 -0
- package/dist/generated/models/MockItemV1.js +2 -0
- package/dist/generated/models/MockItemV1.js.map +1 -0
- package/dist/generated/models/OrgSlugPath.d.ts +2 -0
- package/dist/generated/models/OrgSlugPath.d.ts.map +1 -0
- package/dist/generated/models/OrgSlugPath.js +2 -0
- package/dist/generated/models/OrgSlugPath.js.map +1 -0
- package/dist/generated/models/Problem.d.ts +8 -0
- package/dist/generated/models/Problem.d.ts.map +1 -0
- package/dist/generated/models/Problem.js +2 -0
- package/dist/generated/models/Problem.js.map +1 -0
- package/dist/generated/models/PublicApiIdPath.d.ts +2 -0
- package/dist/generated/models/PublicApiIdPath.d.ts.map +1 -0
- package/dist/generated/models/PublicApiIdPath.js +2 -0
- package/dist/generated/models/PublicApiIdPath.js.map +1 -0
- package/dist/generated/models/PublicApiListItem.d.ts +15 -0
- package/dist/generated/models/PublicApiListItem.d.ts.map +1 -0
- package/dist/generated/models/PublicApiListItem.js +2 -0
- package/dist/generated/models/PublicApiListItem.js.map +1 -0
- package/dist/generated/models/PublicApiMetaV1.d.ts +13 -0
- package/dist/generated/models/PublicApiMetaV1.d.ts.map +1 -0
- package/dist/generated/models/PublicApiMetaV1.js +2 -0
- package/dist/generated/models/PublicApiMetaV1.js.map +1 -0
- package/dist/generated/models/PublicPublishRequestV1.d.ts +65 -0
- package/dist/generated/models/PublicPublishRequestV1.d.ts.map +1 -0
- package/dist/generated/models/PublicPublishRequestV1.js +2 -0
- package/dist/generated/models/PublicPublishRequestV1.js.map +1 -0
- package/dist/generated/models/PublicPublishResponseV1.d.ts +14 -0
- package/dist/generated/models/PublicPublishResponseV1.d.ts.map +1 -0
- package/dist/generated/models/PublicPublishResponseV1.js +2 -0
- package/dist/generated/models/PublicPublishResponseV1.js.map +1 -0
- package/dist/generated/models/PutSpectralRulesetRequestV1.d.ts +4 -0
- package/dist/generated/models/PutSpectralRulesetRequestV1.d.ts.map +1 -0
- package/dist/generated/models/PutSpectralRulesetRequestV1.js +2 -0
- package/dist/generated/models/PutSpectralRulesetRequestV1.js.map +1 -0
- package/dist/generated/models/SpecDiffResponseV1.d.ts +6 -0
- package/dist/generated/models/SpecDiffResponseV1.d.ts.map +1 -0
- package/dist/generated/models/SpecDiffResponseV1.js +2 -0
- package/dist/generated/models/SpecDiffResponseV1.js.map +1 -0
- package/dist/generated/models/SpecVersionListItemV1.d.ts +8 -0
- package/dist/generated/models/SpecVersionListItemV1.d.ts.map +1 -0
- package/dist/generated/models/SpecVersionListItemV1.js +2 -0
- package/dist/generated/models/SpecVersionListItemV1.js.map +1 -0
- package/dist/generated/models/SpectralRulesetResponseV1.d.ts +4 -0
- package/dist/generated/models/SpectralRulesetResponseV1.d.ts.map +1 -0
- package/dist/generated/models/SpectralRulesetResponseV1.js +2 -0
- package/dist/generated/models/SpectralRulesetResponseV1.js.map +1 -0
- package/dist/generated/models/StatusResponseV1.d.ts +4 -0
- package/dist/generated/models/StatusResponseV1.d.ts.map +1 -0
- package/dist/generated/models/StatusResponseV1.js +2 -0
- package/dist/generated/models/StatusResponseV1.js.map +1 -0
- package/dist/generated/models/SyncStatusResponseV1.d.ts +7 -0
- package/dist/generated/models/SyncStatusResponseV1.d.ts.map +1 -0
- package/dist/generated/models/SyncStatusResponseV1.js +2 -0
- package/dist/generated/models/SyncStatusResponseV1.js.map +1 -0
- package/dist/generated/models/VersionDiffResponseV1.d.ts +7 -0
- package/dist/generated/models/VersionDiffResponseV1.d.ts.map +1 -0
- package/dist/generated/models/VersionDiffResponseV1.js +2 -0
- package/dist/generated/models/VersionDiffResponseV1.js.map +1 -0
- package/dist/generated/models/Visibility.d.ts +2 -0
- package/dist/generated/models/Visibility.d.ts.map +1 -0
- package/dist/generated/models/Visibility.js +2 -0
- package/dist/generated/models/Visibility.js.map +1 -0
- package/dist/generated/models/VisibilityUpdateRequestV1.d.ts +5 -0
- package/dist/generated/models/VisibilityUpdateRequestV1.d.ts.map +1 -0
- package/dist/generated/models/VisibilityUpdateRequestV1.js +2 -0
- package/dist/generated/models/VisibilityUpdateRequestV1.js.map +1 -0
- package/dist/generated/services/PublicApisService.d.ts +48 -0
- package/dist/generated/services/PublicApisService.d.ts.map +1 -0
- package/dist/generated/services/PublicApisService.js +88 -0
- package/dist/generated/services/PublicApisService.js.map +1 -0
- package/dist/generated/services/PublicMocksService.d.ts +24 -0
- package/dist/generated/services/PublicMocksService.d.ts.map +1 -0
- package/dist/generated/services/PublicMocksService.js +42 -0
- package/dist/generated/services/PublicMocksService.js.map +1 -0
- package/dist/generated/services/PublicRegistryService.d.ts +43 -0
- package/dist/generated/services/PublicRegistryService.d.ts.map +1 -0
- package/dist/generated/services/PublicRegistryService.js +84 -0
- package/dist/generated/services/PublicRegistryService.js.map +1 -0
- package/dist/generated/services/PublicSpecsService.d.ts +48 -0
- package/dist/generated/services/PublicSpecsService.d.ts.map +1 -0
- package/dist/generated/services/PublicSpecsService.js +71 -0
- package/dist/generated/services/PublicSpecsService.js.map +1 -0
- package/dist/generated/services/PublicSpectralService.d.ts +22 -0
- package/dist/generated/services/PublicSpectralService.d.ts.map +1 -0
- package/dist/generated/services/PublicSpectralService.js +39 -0
- package/dist/generated/services/PublicSpectralService.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -0
- package/package.json +42 -0
- package/src/generated/core/ApiError.ts +25 -0
- package/src/generated/core/ApiRequestOptions.ts +17 -0
- package/src/generated/core/ApiResult.ts +11 -0
- package/src/generated/core/CancelablePromise.ts +131 -0
- package/src/generated/core/OpenAPI.ts +32 -0
- package/src/generated/core/request.ts +322 -0
- package/src/generated/index.ts +38 -0
- package/src/generated/models/AiSearchRequestV1.ts +9 -0
- package/src/generated/models/AiSearchResponseV1.ts +8 -0
- package/src/generated/models/ApiNamePath.ts +5 -0
- package/src/generated/models/AuthError.ts +12 -0
- package/src/generated/models/CreateMockRequestV1.ts +12 -0
- package/src/generated/models/CreateMockResponseV1.ts +15 -0
- package/src/generated/models/MockItemV1.ts +12 -0
- package/src/generated/models/OrgSlugPath.ts +5 -0
- package/src/generated/models/Problem.ts +12 -0
- package/src/generated/models/PublicApiIdPath.ts +5 -0
- package/src/generated/models/PublicApiListItem.ts +19 -0
- package/src/generated/models/PublicApiMetaV1.ts +17 -0
- package/src/generated/models/PublicPublishRequestV1.ts +69 -0
- package/src/generated/models/PublicPublishResponseV1.ts +18 -0
- package/src/generated/models/PutSpectralRulesetRequestV1.ts +8 -0
- package/src/generated/models/SpecDiffResponseV1.ts +10 -0
- package/src/generated/models/SpecVersionListItemV1.ts +12 -0
- package/src/generated/models/SpectralRulesetResponseV1.ts +8 -0
- package/src/generated/models/StatusResponseV1.ts +8 -0
- package/src/generated/models/SyncStatusResponseV1.ts +11 -0
- package/src/generated/models/VersionDiffResponseV1.ts +11 -0
- package/src/generated/models/Visibility.ts +5 -0
- package/src/generated/models/VisibilityUpdateRequestV1.ts +9 -0
- package/src/generated/services/PublicApisService.ts +111 -0
- package/src/generated/services/PublicMocksService.ts +53 -0
- package/src/generated/services/PublicRegistryService.ts +115 -0
- package/src/generated/services/PublicSpecsService.ts +107 -0
- package/src/generated/services/PublicSpectralService.ts +50 -0
- package/src/index.ts +2 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { PublicApiListItem } from '../models/PublicApiListItem';
|
|
2
|
+
import type { PublicApiMetaV1 } from '../models/PublicApiMetaV1';
|
|
3
|
+
import type { PublicPublishRequestV1 } from '../models/PublicPublishRequestV1';
|
|
4
|
+
import type { PublicPublishResponseV1 } from '../models/PublicPublishResponseV1';
|
|
5
|
+
import type { VisibilityUpdateRequestV1 } from '../models/VisibilityUpdateRequestV1';
|
|
6
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
7
|
+
export declare class PublicApisService {
|
|
8
|
+
/**
|
|
9
|
+
* List public APIs for the calling org
|
|
10
|
+
* Org context derived from the calling token's principal.
|
|
11
|
+
* @returns PublicApiListItem Public APIs the calling org owns
|
|
12
|
+
* @throws ApiError
|
|
13
|
+
*/
|
|
14
|
+
static listPublicApis(): CancelablePromise<Array<PublicApiListItem>>;
|
|
15
|
+
/**
|
|
16
|
+
* Publish or update a public API
|
|
17
|
+
* First call (no `publicApiId`) creates a new public API. Subsequent calls with the
|
|
18
|
+
* same `publicApiId` update the existing one. Each call records an immutable version
|
|
19
|
+
* snapshot keyed on `version`.
|
|
20
|
+
*
|
|
21
|
+
* @returns PublicPublishResponseV1 Publish succeeded (idempotent on re-publish of the same tag+spec)
|
|
22
|
+
* @throws ApiError
|
|
23
|
+
*/
|
|
24
|
+
static publishPublicApi({ requestBody, }: {
|
|
25
|
+
requestBody: PublicPublishRequestV1;
|
|
26
|
+
}): CancelablePromise<PublicPublishResponseV1>;
|
|
27
|
+
/**
|
|
28
|
+
* Update visibility for a public API
|
|
29
|
+
* @returns PublicApiMetaV1 Updated visibility
|
|
30
|
+
* @throws ApiError
|
|
31
|
+
*/
|
|
32
|
+
static updatePublicApiVisibility({ publicApiId, requestBody, }: {
|
|
33
|
+
publicApiId: string;
|
|
34
|
+
requestBody: VisibilityUpdateRequestV1;
|
|
35
|
+
}): CancelablePromise<PublicApiMetaV1>;
|
|
36
|
+
/**
|
|
37
|
+
* Soft-delete a public API
|
|
38
|
+
* The API is unpublished and marked deleted. Customers that already have
|
|
39
|
+
* the spec keep working until they re-fetch.
|
|
40
|
+
*
|
|
41
|
+
* @returns void
|
|
42
|
+
* @throws ApiError
|
|
43
|
+
*/
|
|
44
|
+
static deletePublicApi({ publicApiId, }: {
|
|
45
|
+
publicApiId: string;
|
|
46
|
+
}): CancelablePromise<void>;
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=PublicApisService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicApisService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AACrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,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;;;;OAIG;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"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { OpenAPI } from '../core/OpenAPI';
|
|
2
|
+
import { request as __request } from '../core/request';
|
|
3
|
+
export class PublicApisService {
|
|
4
|
+
/**
|
|
5
|
+
* List public APIs for the calling org
|
|
6
|
+
* Org context derived from the calling token's principal.
|
|
7
|
+
* @returns PublicApiListItem Public APIs the calling org owns
|
|
8
|
+
* @throws ApiError
|
|
9
|
+
*/
|
|
10
|
+
static listPublicApis() {
|
|
11
|
+
return __request(OpenAPI, {
|
|
12
|
+
method: 'GET',
|
|
13
|
+
url: '/api/v1/public/apis',
|
|
14
|
+
errors: {
|
|
15
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
16
|
+
403: `Token does not carry the required scope`,
|
|
17
|
+
},
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Publish or update a public API
|
|
22
|
+
* First call (no `publicApiId`) creates a new public API. Subsequent calls with the
|
|
23
|
+
* same `publicApiId` update the existing one. Each call records an immutable version
|
|
24
|
+
* snapshot keyed on `version`.
|
|
25
|
+
*
|
|
26
|
+
* @returns PublicPublishResponseV1 Publish succeeded (idempotent on re-publish of the same tag+spec)
|
|
27
|
+
* @throws ApiError
|
|
28
|
+
*/
|
|
29
|
+
static publishPublicApi({ requestBody, }) {
|
|
30
|
+
return __request(OpenAPI, {
|
|
31
|
+
method: 'POST',
|
|
32
|
+
url: '/api/v1/public/apis',
|
|
33
|
+
body: requestBody,
|
|
34
|
+
mediaType: 'application/json',
|
|
35
|
+
errors: {
|
|
36
|
+
400: `Bad request`,
|
|
37
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
38
|
+
402: `Payment required — the org's plan does not include public-API publishing`,
|
|
39
|
+
403: `Token does not carry the required scope`,
|
|
40
|
+
409: `Version tag already exists with different spec content`,
|
|
41
|
+
},
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Update visibility for a public API
|
|
46
|
+
* @returns PublicApiMetaV1 Updated visibility
|
|
47
|
+
* @throws ApiError
|
|
48
|
+
*/
|
|
49
|
+
static updatePublicApiVisibility({ publicApiId, requestBody, }) {
|
|
50
|
+
return __request(OpenAPI, {
|
|
51
|
+
method: 'PUT',
|
|
52
|
+
url: '/api/v1/public/apis/{publicApiId}/visibility',
|
|
53
|
+
path: {
|
|
54
|
+
'publicApiId': publicApiId,
|
|
55
|
+
},
|
|
56
|
+
body: requestBody,
|
|
57
|
+
mediaType: 'application/json',
|
|
58
|
+
errors: {
|
|
59
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
60
|
+
403: `Token does not carry the required scope`,
|
|
61
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
62
|
+
},
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Soft-delete a public API
|
|
67
|
+
* The API is unpublished and marked deleted. Customers that already have
|
|
68
|
+
* the spec keep working until they re-fetch.
|
|
69
|
+
*
|
|
70
|
+
* @returns void
|
|
71
|
+
* @throws ApiError
|
|
72
|
+
*/
|
|
73
|
+
static deletePublicApi({ publicApiId, }) {
|
|
74
|
+
return __request(OpenAPI, {
|
|
75
|
+
method: 'DELETE',
|
|
76
|
+
url: '/api/v1/public/apis/{publicApiId}',
|
|
77
|
+
path: {
|
|
78
|
+
'publicApiId': publicApiId,
|
|
79
|
+
},
|
|
80
|
+
errors: {
|
|
81
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
82
|
+
403: `Token does not carry the required scope`,
|
|
83
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
84
|
+
},
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
//# sourceMappingURL=PublicApisService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicApisService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACvD,MAAM,OAAO,iBAAiB;IAC5B;;;;;OAKG;IACI,MAAM,CAAC,cAAc;QAC1B,OAAO,SAAS,CAAC,OAAO,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,SAAS,CAAC,OAAO,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;;;;OAIG;IACI,MAAM,CAAC,yBAAyB,CAAC,EACtC,WAAW,EACX,WAAW,GAIZ;QACC,OAAO,SAAS,CAAC,OAAO,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,SAAS,CAAC,OAAO,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"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { CreateMockRequestV1 } from '../models/CreateMockRequestV1';
|
|
2
|
+
import type { CreateMockResponseV1 } from '../models/CreateMockResponseV1';
|
|
3
|
+
import type { MockItemV1 } from '../models/MockItemV1';
|
|
4
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
+
export declare class PublicMocksService {
|
|
6
|
+
/**
|
|
7
|
+
* List mock servers for the calling org
|
|
8
|
+
* @returns MockItemV1 Mock servers
|
|
9
|
+
* @throws ApiError
|
|
10
|
+
*/
|
|
11
|
+
static listPublicMocks(): CancelablePromise<Array<MockItemV1>>;
|
|
12
|
+
/**
|
|
13
|
+
* Create a mock server for a known API
|
|
14
|
+
* Provide either `apiId` or `apiName`. If a mock already exists for the
|
|
15
|
+
* (api, team) pair the existing one is returned (idempotent).
|
|
16
|
+
*
|
|
17
|
+
* @returns CreateMockResponseV1 Mock server (existing or freshly created)
|
|
18
|
+
* @throws ApiError
|
|
19
|
+
*/
|
|
20
|
+
static createPublicMock({ requestBody, }: {
|
|
21
|
+
requestBody: CreateMockRequestV1;
|
|
22
|
+
}): CancelablePromise<CreateMockResponseV1>;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=PublicMocksService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicMocksService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,qBAAa,kBAAkB;IAC7B;;;;OAIG;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;CAc5C"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { OpenAPI } from '../core/OpenAPI';
|
|
2
|
+
import { request as __request } from '../core/request';
|
|
3
|
+
export class PublicMocksService {
|
|
4
|
+
/**
|
|
5
|
+
* List mock servers for the calling org
|
|
6
|
+
* @returns MockItemV1 Mock servers
|
|
7
|
+
* @throws ApiError
|
|
8
|
+
*/
|
|
9
|
+
static listPublicMocks() {
|
|
10
|
+
return __request(OpenAPI, {
|
|
11
|
+
method: 'GET',
|
|
12
|
+
url: '/api/v1/public/mocks',
|
|
13
|
+
errors: {
|
|
14
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
15
|
+
403: `Token does not carry the required scope`,
|
|
16
|
+
},
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Create a mock server for a known API
|
|
21
|
+
* Provide either `apiId` or `apiName`. If a mock already exists for the
|
|
22
|
+
* (api, team) pair the existing one is returned (idempotent).
|
|
23
|
+
*
|
|
24
|
+
* @returns CreateMockResponseV1 Mock server (existing or freshly created)
|
|
25
|
+
* @throws ApiError
|
|
26
|
+
*/
|
|
27
|
+
static createPublicMock({ requestBody, }) {
|
|
28
|
+
return __request(OpenAPI, {
|
|
29
|
+
method: 'POST',
|
|
30
|
+
url: '/api/v1/public/mocks',
|
|
31
|
+
body: requestBody,
|
|
32
|
+
mediaType: 'application/json',
|
|
33
|
+
errors: {
|
|
34
|
+
400: `Bad request`,
|
|
35
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
36
|
+
403: `Token does not carry the required scope`,
|
|
37
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
38
|
+
},
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
//# sourceMappingURL=PublicMocksService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicMocksService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACvD,MAAM,OAAO,kBAAkB;IAC7B;;;;OAIG;IACI,MAAM,CAAC,eAAe;QAC3B,OAAO,SAAS,CAAC,OAAO,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,SAAS,CAAC,OAAO,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;CACF"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import type { AiSearchRequestV1 } from '../models/AiSearchRequestV1';
|
|
2
|
+
import type { AiSearchResponseV1 } from '../models/AiSearchResponseV1';
|
|
3
|
+
import type { SpecVersionListItemV1 } from '../models/SpecVersionListItemV1';
|
|
4
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
+
export declare class PublicRegistryService {
|
|
6
|
+
/**
|
|
7
|
+
* Fetch latest published spec
|
|
8
|
+
* @returns string OpenAPI spec content
|
|
9
|
+
* @throws ApiError
|
|
10
|
+
*/
|
|
11
|
+
static getLatestPublicSpec({ orgSlug, apiName, }: {
|
|
12
|
+
orgSlug: string;
|
|
13
|
+
apiName: string;
|
|
14
|
+
}): CancelablePromise<string>;
|
|
15
|
+
/**
|
|
16
|
+
* List version history
|
|
17
|
+
* @returns SpecVersionListItemV1 Version history
|
|
18
|
+
* @throws ApiError
|
|
19
|
+
*/
|
|
20
|
+
static listPublicSpecVersions({ orgSlug, apiName, }: {
|
|
21
|
+
orgSlug: string;
|
|
22
|
+
apiName: string;
|
|
23
|
+
}): CancelablePromise<Array<SpecVersionListItemV1>>;
|
|
24
|
+
/**
|
|
25
|
+
* Fetch a specific spec version
|
|
26
|
+
* @returns string OpenAPI spec content for the requested version
|
|
27
|
+
* @throws ApiError
|
|
28
|
+
*/
|
|
29
|
+
static getPublicSpecByTag({ orgSlug, apiName, tag, }: {
|
|
30
|
+
orgSlug: string;
|
|
31
|
+
apiName: string;
|
|
32
|
+
tag: string;
|
|
33
|
+
}): CancelablePromise<string>;
|
|
34
|
+
/**
|
|
35
|
+
* Semantic search over the calling org's APIs
|
|
36
|
+
* @returns AiSearchResponseV1 Search results
|
|
37
|
+
* @throws ApiError
|
|
38
|
+
*/
|
|
39
|
+
static searchPublicApis({ requestBody, }: {
|
|
40
|
+
requestBody: AiSearchRequestV1;
|
|
41
|
+
}): CancelablePromise<AiSearchResponseV1>;
|
|
42
|
+
}
|
|
43
|
+
//# sourceMappingURL=PublicRegistryService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicRegistryService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicRegistryService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,qBAAa,qBAAqB;IAChC;;;;OAIG;WACW,mBAAmB,CAAC,EAChC,OAAO,EACP,OAAO,GACR,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAe7B;;;;OAIG;WACW,sBAAsB,CAAC,EACnC,OAAO,EACP,OAAO,GACR,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,iBAAiB,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAenD;;;;OAIG;WACW,kBAAkB,CAAC,EAC/B,OAAO,EACP,OAAO,EACP,GAAG,GACJ,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;KACb,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAgB7B;;;;OAIG;WACW,gBAAgB,CAAC,EAC7B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,iBAAiB,CAAC;KAChC,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;CAa1C"}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { OpenAPI } from '../core/OpenAPI';
|
|
2
|
+
import { request as __request } from '../core/request';
|
|
3
|
+
export class PublicRegistryService {
|
|
4
|
+
/**
|
|
5
|
+
* Fetch latest published spec
|
|
6
|
+
* @returns string OpenAPI spec content
|
|
7
|
+
* @throws ApiError
|
|
8
|
+
*/
|
|
9
|
+
static getLatestPublicSpec({ orgSlug, apiName, }) {
|
|
10
|
+
return __request(OpenAPI, {
|
|
11
|
+
method: 'GET',
|
|
12
|
+
url: '/api/v1/public/registry/{orgSlug}/{apiName}',
|
|
13
|
+
path: {
|
|
14
|
+
'orgSlug': orgSlug,
|
|
15
|
+
'apiName': apiName,
|
|
16
|
+
},
|
|
17
|
+
errors: {
|
|
18
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
19
|
+
403: `Token does not carry the required scope`,
|
|
20
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
21
|
+
},
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* List version history
|
|
26
|
+
* @returns SpecVersionListItemV1 Version history
|
|
27
|
+
* @throws ApiError
|
|
28
|
+
*/
|
|
29
|
+
static listPublicSpecVersions({ orgSlug, apiName, }) {
|
|
30
|
+
return __request(OpenAPI, {
|
|
31
|
+
method: 'GET',
|
|
32
|
+
url: '/api/v1/public/registry/{orgSlug}/{apiName}/versions',
|
|
33
|
+
path: {
|
|
34
|
+
'orgSlug': orgSlug,
|
|
35
|
+
'apiName': apiName,
|
|
36
|
+
},
|
|
37
|
+
errors: {
|
|
38
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
39
|
+
403: `Token does not carry the required scope`,
|
|
40
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
41
|
+
},
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Fetch a specific spec version
|
|
46
|
+
* @returns string OpenAPI spec content for the requested version
|
|
47
|
+
* @throws ApiError
|
|
48
|
+
*/
|
|
49
|
+
static getPublicSpecByTag({ orgSlug, apiName, tag, }) {
|
|
50
|
+
return __request(OpenAPI, {
|
|
51
|
+
method: 'GET',
|
|
52
|
+
url: '/api/v1/public/registry/{orgSlug}/{apiName}/versions/{tag}',
|
|
53
|
+
path: {
|
|
54
|
+
'orgSlug': orgSlug,
|
|
55
|
+
'apiName': apiName,
|
|
56
|
+
'tag': tag,
|
|
57
|
+
},
|
|
58
|
+
errors: {
|
|
59
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
60
|
+
403: `Token does not carry the required scope`,
|
|
61
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
62
|
+
},
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Semantic search over the calling org's APIs
|
|
67
|
+
* @returns AiSearchResponseV1 Search results
|
|
68
|
+
* @throws ApiError
|
|
69
|
+
*/
|
|
70
|
+
static searchPublicApis({ requestBody, }) {
|
|
71
|
+
return __request(OpenAPI, {
|
|
72
|
+
method: 'POST',
|
|
73
|
+
url: '/api/v1/public/registry/search',
|
|
74
|
+
body: requestBody,
|
|
75
|
+
mediaType: 'application/json',
|
|
76
|
+
errors: {
|
|
77
|
+
400: `Bad request`,
|
|
78
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
79
|
+
403: `Token does not carry the required scope`,
|
|
80
|
+
},
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
//# sourceMappingURL=PublicRegistryService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicRegistryService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicRegistryService.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACvD,MAAM,OAAO,qBAAqB;IAChC;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,EAChC,OAAO,EACP,OAAO,GAIR;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,6CAA6C;YAClD,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO;gBAClB,SAAS,EAAE,OAAO;aACnB;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,sBAAsB,CAAC,EACnC,OAAO,EACP,OAAO,GAIR;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,sDAAsD;YAC3D,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO;gBAClB,SAAS,EAAE,OAAO;aACnB;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,EAC/B,OAAO,EACP,OAAO,EACP,GAAG,GAKJ;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,4DAA4D;YACjE,IAAI,EAAE;gBACJ,SAAS,EAAE,OAAO;gBAClB,SAAS,EAAE,OAAO;gBAClB,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;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,EAC7B,WAAW,GAGZ;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,gCAAgC;YACrC,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { SpecDiffResponseV1 } from '../models/SpecDiffResponseV1';
|
|
2
|
+
import type { SyncStatusResponseV1 } from '../models/SyncStatusResponseV1';
|
|
3
|
+
import type { VersionDiffResponseV1 } from '../models/VersionDiffResponseV1';
|
|
4
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
+
export declare class PublicSpecsService {
|
|
6
|
+
/**
|
|
7
|
+
* Compare two arbitrary specs (multipart)
|
|
8
|
+
* oasdiff-backed structured changelog + breaking-change list.
|
|
9
|
+
* @returns SpecDiffResponseV1 Diff result
|
|
10
|
+
* @throws ApiError
|
|
11
|
+
*/
|
|
12
|
+
static diffSpecs({ formData, }: {
|
|
13
|
+
formData: {
|
|
14
|
+
/**
|
|
15
|
+
* Baseline spec file
|
|
16
|
+
*/
|
|
17
|
+
base: Blob;
|
|
18
|
+
/**
|
|
19
|
+
* Revision spec file
|
|
20
|
+
*/
|
|
21
|
+
revision: Blob;
|
|
22
|
+
};
|
|
23
|
+
}): CancelablePromise<SpecDiffResponseV1>;
|
|
24
|
+
/**
|
|
25
|
+
* Diff two published versions of an API
|
|
26
|
+
* @returns VersionDiffResponseV1 Diff result
|
|
27
|
+
* @throws ApiError
|
|
28
|
+
*/
|
|
29
|
+
static getVersionDiff({ apiId, fromTag, toTag, }: {
|
|
30
|
+
apiId: string;
|
|
31
|
+
fromTag: string;
|
|
32
|
+
toTag: string;
|
|
33
|
+
}): CancelablePromise<VersionDiffResponseV1>;
|
|
34
|
+
/**
|
|
35
|
+
* "Is this git SHA the last published spec for this API?"
|
|
36
|
+
* Powers incremental publish in CI — caller posts current `gitSha`, gets back
|
|
37
|
+
* whether a publish is needed.
|
|
38
|
+
*
|
|
39
|
+
* @returns SyncStatusResponseV1 Sync status
|
|
40
|
+
* @throws ApiError
|
|
41
|
+
*/
|
|
42
|
+
static getSyncStatus({ gitSha, apiId, name, }: {
|
|
43
|
+
gitSha: string;
|
|
44
|
+
apiId?: string;
|
|
45
|
+
name?: string;
|
|
46
|
+
}): CancelablePromise<SyncStatusResponseV1>;
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=PublicSpecsService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicSpecsService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicSpecsService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,qBAAa,kBAAkB;IAC7B;;;;;OAKG;WACW,SAAS,CAAC,EACtB,QAAQ,GACT,EAAE;QACD,QAAQ,EAAE;YACR;;eAEG;YACH,IAAI,EAAE,IAAI,CAAC;YACX;;eAEG;YACH,QAAQ,EAAE,IAAI,CAAC;SAChB,CAAC;KACH,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;IAazC;;;;OAIG;WACW,cAAc,CAAC,EAC3B,KAAK,EACL,OAAO,EACP,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAiB5C;;;;;;;OAOG;WACW,aAAa,CAAC,EAC1B,MAAM,EACN,KAAK,EACL,IAAI,GACL,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;CAiB5C"}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { OpenAPI } from '../core/OpenAPI';
|
|
2
|
+
import { request as __request } from '../core/request';
|
|
3
|
+
export class PublicSpecsService {
|
|
4
|
+
/**
|
|
5
|
+
* Compare two arbitrary specs (multipart)
|
|
6
|
+
* oasdiff-backed structured changelog + breaking-change list.
|
|
7
|
+
* @returns SpecDiffResponseV1 Diff result
|
|
8
|
+
* @throws ApiError
|
|
9
|
+
*/
|
|
10
|
+
static diffSpecs({ formData, }) {
|
|
11
|
+
return __request(OpenAPI, {
|
|
12
|
+
method: 'POST',
|
|
13
|
+
url: '/api/v1/public/specs/diff',
|
|
14
|
+
formData: formData,
|
|
15
|
+
mediaType: 'multipart/form-data',
|
|
16
|
+
errors: {
|
|
17
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
18
|
+
403: `Token does not carry the required scope`,
|
|
19
|
+
503: `oasdiff service unavailable in this deployment`,
|
|
20
|
+
},
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Diff two published versions of an API
|
|
25
|
+
* @returns VersionDiffResponseV1 Diff result
|
|
26
|
+
* @throws ApiError
|
|
27
|
+
*/
|
|
28
|
+
static getVersionDiff({ apiId, fromTag, toTag, }) {
|
|
29
|
+
return __request(OpenAPI, {
|
|
30
|
+
method: 'GET',
|
|
31
|
+
url: '/api/v1/public/specs/version-diff',
|
|
32
|
+
query: {
|
|
33
|
+
'apiId': apiId,
|
|
34
|
+
'fromTag': fromTag,
|
|
35
|
+
'toTag': toTag,
|
|
36
|
+
},
|
|
37
|
+
errors: {
|
|
38
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
39
|
+
403: `Token does not carry the required scope`,
|
|
40
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
41
|
+
503: `oasdiff service unavailable`,
|
|
42
|
+
},
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* "Is this git SHA the last published spec for this API?"
|
|
47
|
+
* Powers incremental publish in CI — caller posts current `gitSha`, gets back
|
|
48
|
+
* whether a publish is needed.
|
|
49
|
+
*
|
|
50
|
+
* @returns SyncStatusResponseV1 Sync status
|
|
51
|
+
* @throws ApiError
|
|
52
|
+
*/
|
|
53
|
+
static getSyncStatus({ gitSha, apiId, name, }) {
|
|
54
|
+
return __request(OpenAPI, {
|
|
55
|
+
method: 'GET',
|
|
56
|
+
url: '/api/v1/public/specs/sync-status',
|
|
57
|
+
query: {
|
|
58
|
+
'gitSha': gitSha,
|
|
59
|
+
'apiId': apiId,
|
|
60
|
+
'name': name,
|
|
61
|
+
},
|
|
62
|
+
errors: {
|
|
63
|
+
400: `Bad request`,
|
|
64
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
65
|
+
403: `Token does not carry the required scope`,
|
|
66
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
67
|
+
},
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
//# sourceMappingURL=PublicSpecsService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicSpecsService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicSpecsService.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACvD,MAAM,OAAO,kBAAkB;IAC7B;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,EACtB,QAAQ,GAYT;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,2BAA2B;YAChC,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,qBAAqB;YAChC,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,gDAAgD;aACtD;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,EAC3B,KAAK,EACL,OAAO,EACP,KAAK,GAKN;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,mCAAmC;YACxC,KAAK,EAAE;gBACL,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,OAAO;gBAClB,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;gBAC7D,GAAG,EAAE,6BAA6B;aACnC;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,EAC1B,MAAM,EACN,KAAK,EACL,IAAI,GAKL;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,kCAAkC;YACvC,KAAK,EAAE;gBACL,QAAQ,EAAE,MAAM;gBAChB,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,IAAI;aACb;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;CACF"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { PutSpectralRulesetRequestV1 } from '../models/PutSpectralRulesetRequestV1';
|
|
2
|
+
import type { SpectralRulesetResponseV1 } from '../models/SpectralRulesetResponseV1';
|
|
3
|
+
import type { StatusResponseV1 } from '../models/StatusResponseV1';
|
|
4
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
5
|
+
export declare class PublicSpectralService {
|
|
6
|
+
/**
|
|
7
|
+
* Get the calling org's Spectral ruleset
|
|
8
|
+
* @returns SpectralRulesetResponseV1 Current ruleset
|
|
9
|
+
* @throws ApiError
|
|
10
|
+
*/
|
|
11
|
+
static getSpectralRuleset(): CancelablePromise<SpectralRulesetResponseV1>;
|
|
12
|
+
/**
|
|
13
|
+
* Update the calling org's Spectral ruleset
|
|
14
|
+
* Plan-gated — requires Pro or higher. Built-in rulesets are always available.
|
|
15
|
+
* @returns StatusResponseV1 Updated
|
|
16
|
+
* @throws ApiError
|
|
17
|
+
*/
|
|
18
|
+
static putSpectralRuleset({ requestBody, }: {
|
|
19
|
+
requestBody: PutSpectralRulesetRequestV1;
|
|
20
|
+
}): CancelablePromise<StatusResponseV1>;
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=PublicSpectralService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicSpectralService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicSpectralService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACzF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AACrF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,qBAAa,qBAAqB;IAChC;;;;OAIG;WACW,kBAAkB,IAAI,iBAAiB,CAAC,yBAAyB,CAAC;IAUhF;;;;;OAKG;WACW,kBAAkB,CAAC,EAC/B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,2BAA2B,CAAC;KAC1C,GAAG,iBAAiB,CAAC,gBAAgB,CAAC;CAaxC"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { OpenAPI } from '../core/OpenAPI';
|
|
2
|
+
import { request as __request } from '../core/request';
|
|
3
|
+
export class PublicSpectralService {
|
|
4
|
+
/**
|
|
5
|
+
* Get the calling org's Spectral ruleset
|
|
6
|
+
* @returns SpectralRulesetResponseV1 Current ruleset
|
|
7
|
+
* @throws ApiError
|
|
8
|
+
*/
|
|
9
|
+
static getSpectralRuleset() {
|
|
10
|
+
return __request(OpenAPI, {
|
|
11
|
+
method: 'GET',
|
|
12
|
+
url: '/api/v1/public/spectral/ruleset',
|
|
13
|
+
errors: {
|
|
14
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
15
|
+
403: `Token does not carry the required scope`,
|
|
16
|
+
},
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Update the calling org's Spectral ruleset
|
|
21
|
+
* Plan-gated — requires Pro or higher. Built-in rulesets are always available.
|
|
22
|
+
* @returns StatusResponseV1 Updated
|
|
23
|
+
* @throws ApiError
|
|
24
|
+
*/
|
|
25
|
+
static putSpectralRuleset({ requestBody, }) {
|
|
26
|
+
return __request(OpenAPI, {
|
|
27
|
+
method: 'PUT',
|
|
28
|
+
url: '/api/v1/public/spectral/ruleset',
|
|
29
|
+
body: requestBody,
|
|
30
|
+
mediaType: 'application/json',
|
|
31
|
+
errors: {
|
|
32
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
33
|
+
402: `Payment required — custom rulesets need a paid plan`,
|
|
34
|
+
403: `Token does not carry the required scope`,
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
//# sourceMappingURL=PublicSpectralService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PublicSpectralService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicSpectralService.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACvD,MAAM,OAAO,qBAAqB;IAChC;;;;OAIG;IACI,MAAM,CAAC,kBAAkB;QAC9B,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iCAAiC;YACtC,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,EAC/B,WAAW,GAGZ;QACC,OAAO,SAAS,CAAC,OAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iCAAiC;YACtC,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,qDAAqD;gBAC1D,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,cAAc,aAAa,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@spec0/sdk-public-platform",
|
|
3
|
+
"version": "1.1.0",
|
|
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
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "./dist/index.js",
|
|
8
|
+
"module": "./dist/index.js",
|
|
9
|
+
"types": "./dist/index.d.ts",
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"import": "./dist/index.js"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"dist",
|
|
18
|
+
"src",
|
|
19
|
+
"README.md"
|
|
20
|
+
],
|
|
21
|
+
"publishConfig": {
|
|
22
|
+
"access": "public",
|
|
23
|
+
"registry": "https://registry.npmjs.org"
|
|
24
|
+
},
|
|
25
|
+
"repository": {
|
|
26
|
+
"type": "git",
|
|
27
|
+
"url": "https://github.com/spec-0/spec0-platform.git",
|
|
28
|
+
"directory": "packages/sdk-public-platform"
|
|
29
|
+
},
|
|
30
|
+
"scripts": {
|
|
31
|
+
"generate": "tsx scripts/generate.ts",
|
|
32
|
+
"build": "tsc -p tsconfig.json",
|
|
33
|
+
"clean": "rm -rf dist src/generated",
|
|
34
|
+
"prepack": "npm run clean && npm run generate && npm run build",
|
|
35
|
+
"verify": "npm run generate && npm run build"
|
|
36
|
+
},
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"openapi-typescript-codegen": "^0.29.0",
|
|
39
|
+
"tsx": "^4.7.0",
|
|
40
|
+
"typescript": "^5.4.0"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
import type { ApiRequestOptions } from './ApiRequestOptions';
|
|
6
|
+
import type { ApiResult } from './ApiResult';
|
|
7
|
+
|
|
8
|
+
export class ApiError extends Error {
|
|
9
|
+
public readonly url: string;
|
|
10
|
+
public readonly status: number;
|
|
11
|
+
public readonly statusText: string;
|
|
12
|
+
public readonly body: any;
|
|
13
|
+
public readonly request: ApiRequestOptions;
|
|
14
|
+
|
|
15
|
+
constructor(request: ApiRequestOptions, response: ApiResult, message: string) {
|
|
16
|
+
super(message);
|
|
17
|
+
|
|
18
|
+
this.name = 'ApiError';
|
|
19
|
+
this.url = response.url;
|
|
20
|
+
this.status = response.status;
|
|
21
|
+
this.statusText = response.statusText;
|
|
22
|
+
this.body = response.body;
|
|
23
|
+
this.request = request;
|
|
24
|
+
}
|
|
25
|
+
}
|