@spec0/sdk-public-platform 1.15.0 → 1.17.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/models/PublicPublishRequestV1.d.ts +20 -0
- package/dist/generated/models/PublicPublishRequestV1.d.ts.map +1 -1
- package/dist/generated/models/PublicPublishResponseV1.d.ts +18 -2
- package/dist/generated/models/PublicPublishResponseV1.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/generated/models/PublicPublishRequestV1.ts +20 -0
- package/src/generated/models/PublicPublishResponseV1.ts +18 -2
|
@@ -92,5 +92,25 @@ export type PublicPublishRequestV1 = {
|
|
|
92
92
|
* MIRRORED only — the producer's official developer docs URL
|
|
93
93
|
*/
|
|
94
94
|
originDocsUrl?: string;
|
|
95
|
+
/**
|
|
96
|
+
* MIRRORED only — the upstream commit this snapshot was taken from. Distinct from `gitSha`, which is a SHA-256 of the spec file's bytes and exists in no repository.
|
|
97
|
+
*/
|
|
98
|
+
originCommitSha?: string;
|
|
99
|
+
/**
|
|
100
|
+
* MIRRORED only — web URL for `originCommitSha`. Supplied by the publisher rather than derived, so the registry invents no per-host URL rules.
|
|
101
|
+
*/
|
|
102
|
+
originCommitUrl?: string;
|
|
103
|
+
/**
|
|
104
|
+
* Reserved for the Spec0 mirror pipeline, which republishes third-party specifications under their own vendor's slug (`/registry/{vendorSlug}/{apiSlug}`). Publishing into an organisation you are not a member of needs a scope that customer tokens cannot be issued with, so a token from the dashboard is refused with 403. Documented because it appears on the wire, not because it is a field to set.
|
|
105
|
+
*/
|
|
106
|
+
vendorSlug?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Display name for the vendor organisation, used only when that organisation is first created. Same reservation as `vendorSlug`.
|
|
109
|
+
*/
|
|
110
|
+
vendorName?: string;
|
|
111
|
+
/**
|
|
112
|
+
* The vendor's own website, shown on their registry organisation page. Same reservation as `vendorSlug`.
|
|
113
|
+
*/
|
|
114
|
+
vendorWebsiteUrl?: string;
|
|
95
115
|
};
|
|
96
116
|
//# sourceMappingURL=PublicPublishRequestV1.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicPublishRequestV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/PublicPublishRequestV1.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"PublicPublishRequestV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/PublicPublishRequestV1.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}
|
|
@@ -11,10 +11,26 @@ export type PublicPublishResponseV1 = {
|
|
|
11
11
|
versionCreated?: boolean;
|
|
12
12
|
publicUrl?: string;
|
|
13
13
|
/**
|
|
14
|
-
* Lint score (0-100) computed synchronously for MIRRORED publishes
|
|
15
|
-
*
|
|
14
|
+
* Lint score (0-100), computed synchronously for MIRRORED publishes. Null for
|
|
15
|
+
* AUTHORED publishes, which are scored asynchronously after the commit.
|
|
16
|
+
*
|
|
17
|
+
* A low score does not refuse a publish. Read it with the two counts below:
|
|
18
|
+
* a score dragged down entirely by missing descriptions says something very
|
|
19
|
+
* different about an API than the same score with broken references in it.
|
|
16
20
|
*
|
|
17
21
|
*/
|
|
18
22
|
lintScore?: number;
|
|
23
|
+
/**
|
|
24
|
+
* Structural findings — a broken reference, an invalid schema, a duplicated
|
|
25
|
+
* operationId. Zero means the document holds together.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
lintErrorCount?: number;
|
|
29
|
+
/**
|
|
30
|
+
* Style and completeness findings — a missing parameter description, an
|
|
31
|
+
* orphaned definition. Reported separately from errors on purpose.
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
lintWarningCount?: number;
|
|
19
35
|
};
|
|
20
36
|
//# sourceMappingURL=PublicPublishResponseV1.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicPublishResponseV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/PublicPublishResponseV1.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,
|
|
1
|
+
{"version":3,"file":"PublicPublishResponseV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/PublicPublishResponseV1.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spec0/sdk-public-platform",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.17.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",
|
|
@@ -96,5 +96,25 @@ export type PublicPublishRequestV1 = {
|
|
|
96
96
|
* MIRRORED only — the producer's official developer docs URL
|
|
97
97
|
*/
|
|
98
98
|
originDocsUrl?: string;
|
|
99
|
+
/**
|
|
100
|
+
* MIRRORED only — the upstream commit this snapshot was taken from. Distinct from `gitSha`, which is a SHA-256 of the spec file's bytes and exists in no repository.
|
|
101
|
+
*/
|
|
102
|
+
originCommitSha?: string;
|
|
103
|
+
/**
|
|
104
|
+
* MIRRORED only — web URL for `originCommitSha`. Supplied by the publisher rather than derived, so the registry invents no per-host URL rules.
|
|
105
|
+
*/
|
|
106
|
+
originCommitUrl?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Reserved for the Spec0 mirror pipeline, which republishes third-party specifications under their own vendor's slug (`/registry/{vendorSlug}/{apiSlug}`). Publishing into an organisation you are not a member of needs a scope that customer tokens cannot be issued with, so a token from the dashboard is refused with 403. Documented because it appears on the wire, not because it is a field to set.
|
|
109
|
+
*/
|
|
110
|
+
vendorSlug?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Display name for the vendor organisation, used only when that organisation is first created. Same reservation as `vendorSlug`.
|
|
113
|
+
*/
|
|
114
|
+
vendorName?: string;
|
|
115
|
+
/**
|
|
116
|
+
* The vendor's own website, shown on their registry organisation page. Same reservation as `vendorSlug`.
|
|
117
|
+
*/
|
|
118
|
+
vendorWebsiteUrl?: string;
|
|
99
119
|
};
|
|
100
120
|
|
|
@@ -15,10 +15,26 @@ export type PublicPublishResponseV1 = {
|
|
|
15
15
|
versionCreated?: boolean;
|
|
16
16
|
publicUrl?: string;
|
|
17
17
|
/**
|
|
18
|
-
* Lint score (0-100) computed synchronously for MIRRORED publishes
|
|
19
|
-
*
|
|
18
|
+
* Lint score (0-100), computed synchronously for MIRRORED publishes. Null for
|
|
19
|
+
* AUTHORED publishes, which are scored asynchronously after the commit.
|
|
20
|
+
*
|
|
21
|
+
* A low score does not refuse a publish. Read it with the two counts below:
|
|
22
|
+
* a score dragged down entirely by missing descriptions says something very
|
|
23
|
+
* different about an API than the same score with broken references in it.
|
|
20
24
|
*
|
|
21
25
|
*/
|
|
22
26
|
lintScore?: number;
|
|
27
|
+
/**
|
|
28
|
+
* Structural findings — a broken reference, an invalid schema, a duplicated
|
|
29
|
+
* operationId. Zero means the document holds together.
|
|
30
|
+
*
|
|
31
|
+
*/
|
|
32
|
+
lintErrorCount?: number;
|
|
33
|
+
/**
|
|
34
|
+
* Style and completeness findings — a missing parameter description, an
|
|
35
|
+
* orphaned definition. Reported separately from errors on purpose.
|
|
36
|
+
*
|
|
37
|
+
*/
|
|
38
|
+
lintWarningCount?: number;
|
|
23
39
|
};
|
|
24
40
|
|