@spec0/sdk-public-platform 1.0.0

package/src/generated/index.ts

@@ -0,0 +1,48 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export { ApiError } from './core/ApiError';
+export { CancelablePromise, CancelError } from './core/CancelablePromise';
+export { OpenAPI } from './core/OpenAPI';
+export type { OpenAPIConfig } from './core/OpenAPI';
+
+export type { AiSearchRequestV1 } from './models/AiSearchRequestV1';
+export type { AiSearchResponseV1 } from './models/AiSearchResponseV1';
+export type { ApiNamePath } from './models/ApiNamePath';
+export type { ApiTeamListItemV1 } from './models/ApiTeamListItemV1';
+export type { AuthError } from './models/AuthError';
+export type { CiConfigResponseV1 } from './models/CiConfigResponseV1';
+export type { CreateMockRequestV1 } from './models/CreateMockRequestV1';
+export type { CreateMockResponseV1 } from './models/CreateMockResponseV1';
+export type { MockItemV1 } from './models/MockItemV1';
+export type { OrgSlugPath } from './models/OrgSlugPath';
+export type { OrgSummaryResponseV1 } from './models/OrgSummaryResponseV1';
+export type { Problem } from './models/Problem';
+export type { PublicApiIdPath } from './models/PublicApiIdPath';
+export type { PublicApiListItem } from './models/PublicApiListItem';
+export type { PublicApiMetaV1 } from './models/PublicApiMetaV1';
+export type { PublicPublishRequestV1 } from './models/PublicPublishRequestV1';
+export type { PublicPublishResponseV1 } from './models/PublicPublishResponseV1';
+export type { PutSpectralRulesetRequestV1 } from './models/PutSpectralRulesetRequestV1';
+export type { SpecDiffResponseV1 } from './models/SpecDiffResponseV1';
+export type { SpectralRulesetResponseV1 } from './models/SpectralRulesetResponseV1';
+export type { SpecVersionListItemV1 } from './models/SpecVersionListItemV1';
+export type { StatusResponseV1 } from './models/StatusResponseV1';
+export type { SyncStatusResponseV1 } from './models/SyncStatusResponseV1';
+export type { TeamCreateRequestV1 } from './models/TeamCreateRequestV1';
+export type { TeamPublishRequestV1 } from './models/TeamPublishRequestV1';
+export type { TeamPublishResponseV1 } from './models/TeamPublishResponseV1';
+export type { TeamV1 } from './models/TeamV1';
+export type { VersionDiffResponseV1 } from './models/VersionDiffResponseV1';
+export type { Visibility } from './models/Visibility';
+export type { VisibilityUpdateRequestV1 } from './models/VisibilityUpdateRequestV1';
+
+export { PublicApisService } from './services/PublicApisService';
+export { PublicCiService } from './services/PublicCiService';
+export { PublicMocksService } from './services/PublicMocksService';
+export { PublicOrgsService } from './services/PublicOrgsService';
+export { PublicRegistryService } from './services/PublicRegistryService';
+export { PublicSpecsService } from './services/PublicSpecsService';
+export { PublicSpectralService } from './services/PublicSpectralService';
+export { PublicTeamsService } from './services/PublicTeamsService';

package/src/generated/models/AiSearchRequestV1.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type AiSearchRequestV1 = {
+  query: string;
+  maxResults?: number;
+};
+

package/src/generated/models/AiSearchResponseV1.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type AiSearchResponseV1 = {
+  results?: Array<Record<string, any>>;
+};
+

package/src/generated/models/ApiNamePath.ts

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ApiNamePath = string;

package/src/generated/models/ApiTeamListItemV1.ts

@@ -0,0 +1,28 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * A team-scoped private API in the calling org. Distinct from
+ * `PublicApiListItem`, which describes a record in the public registry.
+ *
+ */
+export type ApiTeamListItemV1 = {
+  apiId?: string;
+  /**
+   * Kebab-case slug used in CLI commands and registry URLs.
+   */
+  apiName?: string;
+  /**
+   * Latest published `info.version` from the OpenAPI spec.
+   */
+  version?: string | null;
+  description?: string | null;
+  teamId?: string | null;
+  teamName?: string | null;
+  /**
+   * ISO local date-time of the last update.
+   */
+  updatedAt?: string | null;
+};
+

package/src/generated/models/AuthError.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type AuthError = {
+  /**
+   * Stable machine-readable code (e.g. `missing_token`, `token_expired`, `invalid_token`)
+   */
+  error?: string;
+  message?: string;
+};
+

package/src/generated/models/CiConfigResponseV1.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CiConfigResponseV1 = {
+  /**
+   * Ready-to-use GitHub Actions workflow YAML.
+   */
+  workflowYaml?: string;
+  /**
+   * Suggested file path for the workflow.
+   */
+  filePath?: string;
+};
+

package/src/generated/models/CreateMockRequestV1.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CreateMockRequestV1 = {
+  /**
+   * Provide either apiId or apiName
+   */
+  apiId?: string;
+  apiName?: string;
+};
+

package/src/generated/models/CreateMockResponseV1.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type CreateMockResponseV1 = {
+  mockServerId?: string;
+  apiName?: string;
+  mockBaseUrl?: string;
+  created?: boolean;
+  /**
+   * Mock-server API key, returned only on first creation
+   */
+  apiKey?: string | null;
+};
+

package/src/generated/models/MockItemV1.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MockItemV1 = {
+  mockServerId?: string;
+  apiId?: string;
+  apiName?: string;
+  name?: string;
+  mockBaseUrl?: string;
+};
+

package/src/generated/models/OrgSlugPath.ts

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type OrgSlugPath = string;

package/src/generated/models/OrgSummaryResponseV1.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Org-level resource counts and current plan.
+ */
+export type OrgSummaryResponseV1 = {
+  apiCount?: number;
+  mockServerCount?: number;
+  teamCount?: number;
+  /**
+   * Current plan id (e.g. `free`, `pro`).
+   */
+  plan?: string;
+};
+

package/src/generated/models/Problem.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type Problem = {
+  status?: number;
+  title?: string;
+  detail?: string;
+  type?: string;
+  instance?: string;
+};
+

package/src/generated/models/PublicApiIdPath.ts

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PublicApiIdPath = string;

package/src/generated/models/PublicApiListItem.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Visibility } from './Visibility';
+export type PublicApiListItem = {
+  publicApiId?: string;
+  apiSlug?: string;
+  title?: string;
+  description?: string;
+  visibility?: Visibility;
+  latestVersion?: string;
+  /**
+   * ISO local date-time
+   */
+  publishedAt?: string;
+  updatedAt?: string;
+};
+

package/src/generated/models/PublicApiMetaV1.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Visibility } from './Visibility';
+export type PublicApiMetaV1 = {
+  publicApiId?: string;
+  orgSlug?: string;
+  apiSlug?: string;
+  title?: string;
+  description?: string;
+  visibility?: Visibility;
+  latestVersion?: string;
+  publishedAt?: string;
+  updatedAt?: string;
+};
+

package/src/generated/models/PublicPublishRequestV1.ts

@@ -0,0 +1,69 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Visibility } from './Visibility';
+/**
+ * Provide exactly one of `version` or `versionBump`. `version` pins an explicit
+ * semver tag. `versionBump` asks the registry to compute the next version
+ * atomically from the highest existing clean-semver tag — preferred for
+ * CI publishes since it avoids races between concurrent main pushes.
+ *
+ */
+export type PublicPublishRequestV1 = {
+  /**
+   * Omit on first publish; required when updating a known API
+   */
+  publicApiId?: string;
+  /**
+   * Required on first publish; URL-safe kebab-case
+   */
+  apiSlug?: string;
+  /**
+   * Required on first publish
+   */
+  title?: string;
+  description?: string;
+  visibility?: Visibility;
+  /**
+   * Explicit semver tag for this version (e.g. "1.2.0"). Mutually
+   * exclusive with `versionBump`.
+   *
+   */
+  version?: string;
+  /**
+   * Ask the registry to compute the next version. `MINOR` bumps the minor
+   * segment of the highest existing clean-semver tag (1.4.0 → 1.5.0);
+   * `PATCH` bumps the patch segment. The very first publish to an API
+   * (no clean-semver tag exists) always goes at "1.0.0" regardless of
+   * bump type. `MAJOR` is intentionally not supported — per Spec0's
+   * versioning policy, breaking changes create a new API rather than
+   * bumping the major version. Mutually exclusive with `version`.
+   * Resolution and version-row insert are wrapped in a single
+   * transaction with a pessimistic lock on the api row, so concurrent
+   * publishes serialise cleanly.
+   *
+   */
+  versionBump?: 'MINOR' | 'PATCH';
+  /**
+   * Full OpenAPI spec content (YAML or JSON)
+   */
+  openapiSpec: string;
+  /**
+   * Optional provenance — git commit SHA for the spec source
+   */
+  gitSha?: string;
+  /**
+   * Human-readable summary of changes in this version
+   */
+  releaseNotes?: string;
+  /**
+   * Optional caller identifier — surfaced on the published version to help
+   * tell apart publishes from CI vs. local CLI vs. third-party tooling. Free-form
+   * string (e.g. "github-actions/public-api-ci", "spec0-cli/0.1.4"). Ignored
+   * when omitted; intended for observability rather than authorization.
+   *
+   */
+  clientName?: string;
+};
+

package/src/generated/models/PublicPublishResponseV1.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PublicPublishResponseV1 = {
+  publicApiId?: string;
+  apiSlug?: string;
+  orgSlug?: string;
+  version?: string;
+  visibility?: string;
+  /**
+   * True iff this call created the API (vs updated existing)
+   */
+  created?: boolean;
+  versionCreated?: boolean;
+  publicUrl?: string;
+};
+

package/src/generated/models/PutSpectralRulesetRequestV1.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PutSpectralRulesetRequestV1 = {
+  rulesetYaml: string;
+};
+

package/src/generated/models/SpecDiffResponseV1.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SpecDiffResponseV1 = {
+  hasBreakingChanges?: boolean;
+  changelog?: Record<string, any>;
+  breakingChanges?: Array<Record<string, any>>;
+};
+

package/src/generated/models/SpecVersionListItemV1.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SpecVersionListItemV1 = {
+  tag?: string;
+  gitSha?: string | null;
+  publishedAt?: string | null;
+  breakingChangesRecorded?: boolean;
+  breakingChangeSummary?: string | null;
+};
+

package/src/generated/models/SpectralRulesetResponseV1.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SpectralRulesetResponseV1 = {
+  rulesetYaml?: string;
+};
+

package/src/generated/models/StatusResponseV1.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type StatusResponseV1 = {
+  status?: string;
+};
+

package/src/generated/models/SyncStatusResponseV1.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SyncStatusResponseV1 = {
+  apiId?: string | null;
+  needsPublish?: boolean;
+  lastPublishedSha?: string | null;
+  lastPublishedVersion?: string | null;
+};
+

package/src/generated/models/TeamCreateRequestV1.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TeamCreateRequestV1 = {
+  /**
+   * Team display name. Must be non-blank.
+   */
+  name: string;
+  description?: string | null;
+};
+

package/src/generated/models/TeamPublishRequestV1.ts

@@ -0,0 +1,57 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request body for publishing a team-scoped private API. Mirrors the shape of the
+ * legacy `CliPublishRequest` (operationId `publishCliSpec`) consumed by `spec0 push`.
+ *
+ */
+export type TeamPublishRequestV1 = {
+  /**
+   * Existing API id. Optional — slug-based upsert by (org, `name`) is preferred.
+   *
+   */
+  apiId?: string;
+  /**
+   * API name (kebab-case). If omitted, derived from the basename of `specFilePath`
+   * (e.g. `api/payment-api.yaml` → `payment-api`).
+   *
+   */
+  name?: string;
+  /**
+   * Team UUID OR slug. When omitted, the API is placed in the org's
+   * "Unassigned APIs" team.
+   *
+   */
+  team?: string;
+  /**
+   * Semver version to publish (MAJOR.MINOR.PATCH). If omitted, the version is
+   * extracted from `info.version` in the spec. Ignored when `semver` is true.
+   *
+   */
+  version?: string;
+  /**
+   * OpenAPI document content (YAML or JSON).
+   */
+  openapiSpec: string;
+  /**
+   * Git commit SHA of the spec file. Used as the primary change detector. If
+   * unchanged since last publish, the request is treated as a no-op.
+   *
+   */
+  gitSha?: string;
+  githubRepo?: string;
+  githubBranch?: string;
+  /**
+   * Path to the spec file in the repository. Used to derive API name when `name` is omitted.
+   */
+  specFilePath?: string;
+  /**
+   * If true, the backend runs oasdiff to classify the change and auto-computes
+   * the next semver tag (PATCH / NON_BREAKING / BREAKING).
+   *
+   */
+  semver?: boolean;
+};
+

package/src/generated/models/TeamPublishResponseV1.ts

@@ -0,0 +1,34 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type TeamPublishResponseV1 = {
+  apiId?: string;
+  specRecordId?: string;
+  version?: string;
+  /**
+   * True if a new API entity was created.
+   */
+  created?: boolean;
+  /**
+   * True if a new version snapshot was created.
+   */
+  versionCreated?: boolean;
+  /**
+   * True if the gitSha matched the last published SHA.
+   */
+  noChanges?: boolean;
+  /**
+   * True when spec changed but `info.version` did not.
+   */
+  versionUnchanged?: boolean;
+  /**
+   * Human-readable hint shown when `versionUnchanged` is true.
+   */
+  versionUnchangedHint?: string;
+  apiName?: string;
+  teamName?: string;
+  orgSlug?: string;
+  registryUrl?: string;
+};
+

package/src/generated/models/TeamV1.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * A team in the calling org.
+ */
+export type TeamV1 = {
+  id?: string;
+  name?: string;
+  description?: string | null;
+  orgId?: string;
+};
+

package/src/generated/models/VersionDiffResponseV1.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type VersionDiffResponseV1 = {
+  fromTag?: string;
+  toTag?: string;
+  changelog?: Record<string, any>;
+  breakingChanges?: Array<Record<string, any>>;
+};
+

package/src/generated/models/Visibility.ts

@@ -0,0 +1,5 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type Visibility = 'DRAFT' | 'PUBLISHED' | 'UNLISTED';

package/src/generated/models/VisibilityUpdateRequestV1.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Visibility } from './Visibility';
+export type VisibilityUpdateRequestV1 = {
+  visibility: Visibility;
+};
+