@spec0/sdk-public-platform 1.2.1 → 1.4.0

package/src/generated/services/PublicRegistryService.ts

@@ -2,15 +2,20 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { AiSearchRequestV1 } from '../models/AiSearchRequestV1';
-import type { AiSearchResponseV1 } from '../models/AiSearchResponseV1';
-import type { SpecVersionListItemV1 } from '../models/SpecVersionListItemV1';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
+import type { AiSearchRequestV1 } from '../models/AiSearchRequestV1.js';
+import type { AiSearchResponseV1 } from '../models/AiSearchResponseV1.js';
+import type { SpecVersionListItemV1 } from '../models/SpecVersionListItemV1.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
 export class PublicRegistryService {
   /**
    * Fetch latest published spec
+   * Returns the raw OpenAPI document of the most recently published version of the
+   * API, addressed by its org slug and API name. This is the canonical entry point
+   * for SDK generators and the `spec0 pull` CLI command — it short-circuits the
+   * version-listing round-trip when the caller just wants "the current spec".
+   *
    * @returns string OpenAPI spec content
    * @throws ApiError
    */
@@ -37,6 +42,12 @@ export class PublicRegistryService {
   }
   /**
    * List version history
+   * Returns every published version of the API in reverse-chronological order,
+   * including the SemVer tag, git SHA recorded at publish, publish timestamp, and a
+   * flag indicating whether breaking changes were detected against the previous
+   * version. The spec content itself is not inlined — fetch individual versions with
+   * `GET /versions/{tag}`.
+   *
    * @returns SpecVersionListItemV1 Version history
    * @throws ApiError
    */
@@ -63,6 +74,11 @@ export class PublicRegistryService {
   }
   /**
    * Fetch a specific spec version
+   * Returns the immutable OpenAPI document published under the given SemVer tag.
+   * Use this when a consumer needs to pin to a specific contract — e.g. CI
+   * regenerating SDKs from `1.2.3` even after `1.3.0` ships. Returns 404 if either
+   * the API or that specific tag does not exist.
+   *
    * @returns string OpenAPI spec content for the requested version
    * @throws ApiError
    */
@@ -92,6 +108,12 @@ export class PublicRegistryService {
   }
   /**
    * Semantic search over the calling org's APIs
+   * Natural-language search across the calling org's API titles, descriptions, and
+   * operation summaries, backed by the RAG service. Results are ranked by semantic
+   * similarity to `query` and capped at `maxResults` (default 10). Scope is
+   * org-internal — the token's org is the only corpus searched; there is no
+   * cross-org discovery on this endpoint.
+   *
    * @returns AiSearchResponseV1 Search results
    * @throws ApiError
    */

package/src/generated/services/PublicSpecsService.ts

@@ -2,12 +2,12 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { SpecDiffResponseV1 } from '../models/SpecDiffResponseV1';
-import type { SyncStatusResponseV1 } from '../models/SyncStatusResponseV1';
-import type { VersionDiffResponseV1 } from '../models/VersionDiffResponseV1';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
+import type { SpecDiffResponseV1 } from '../models/SpecDiffResponseV1.js';
+import type { SyncStatusResponseV1 } from '../models/SyncStatusResponseV1.js';
+import type { VersionDiffResponseV1 } from '../models/VersionDiffResponseV1.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
 export class PublicSpecsService {
   /**
    * Compare two arbitrary specs (multipart)
@@ -43,6 +43,13 @@ export class PublicSpecsService {
   }
   /**
    * Diff two published versions of an API
+   * Compares two already-published versions of the same API (addressed by `apiId` +
+   * `fromTag` + `toTag`) and returns the oasdiff-backed structured changelog plus a
+   * breaking-change list. Lighter-weight than the multipart `/specs/diff` endpoint
+   * because the caller doesn't have to upload either spec — the backend reads them
+   * from its own version history. Returns 503 if the oasdiff service is disabled in
+   * this deployment.
+   *
    * @returns VersionDiffResponseV1 Diff result
    * @throws ApiError
    */

package/src/generated/services/PublicSpectralService.ts

@@ -2,15 +2,20 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { PutSpectralRulesetRequestV1 } from '../models/PutSpectralRulesetRequestV1';
-import type { SpectralRulesetResponseV1 } from '../models/SpectralRulesetResponseV1';
-import type { StatusResponseV1 } from '../models/StatusResponseV1';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
+import type { PutSpectralRulesetRequestV1 } from '../models/PutSpectralRulesetRequestV1.js';
+import type { SpectralRulesetResponseV1 } from '../models/SpectralRulesetResponseV1.js';
+import type { StatusResponseV1 } from '../models/StatusResponseV1.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
 export class PublicSpectralService {
   /**
    * Get the calling org's Spectral ruleset
+   * Returns the org's custom Spectral ruleset YAML, or an empty string when the org
+   * has not configured one. The CLI fetches this on every `spec0 lint` invocation so
+   * lint behaviour stays consistent between local dev and CI. Built-in rulesets are
+   * applied regardless of whether a custom ruleset is set.
+   *
    * @returns SpectralRulesetResponseV1 Current ruleset
    * @throws ApiError
    */

package/src/generated/services/PublicTeamsService.ts

@@ -2,14 +2,19 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { TeamCreateRequestV1 } from '../models/TeamCreateRequestV1';
-import type { TeamV1 } from '../models/TeamV1';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
+import type { TeamCreateRequestV1 } from '../models/TeamCreateRequestV1.js';
+import type { TeamV1 } from '../models/TeamV1.js';
+import type { CancelablePromise } from '../core/CancelablePromise.js';
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
 export class PublicTeamsService {
   /**
    * List teams for the calling org
+   * Returns every team in the calling token's org with its id, name, and
+   * description. Use this to resolve a team slug or human-readable name to the UUID
+   * expected by other endpoints (e.g. `team` on team-API publish, or `teamId` on
+   * delete). Scope is org-internal — teams in other orgs are never returned.
+   *
    * @returns TeamV1 Teams in the calling org
    * @throws ApiError
    */

package/src/index.ts

@@ -1,2 +1,2 @@
 // Generated entry — re-exports the openapi-typescript-codegen output.
-export * from "./generated";
+export * from "./generated/index.js";