artifacts · version 0.1.0

Publish generated docs to a Sourced-managed subpath

POST /api/runs/{runId}/docs-preview/publish

Creates or reuses a Sourced-hosted docs URL from the generated docs preview. This is an internal Sourced subpath publication, not a registry write or custom-domain cutover, and it stays noindex until production indexability is approved.

Request

POST https://sourced.sh/api/runs/{runId}/docs-preview/publish

Parameters

Responses

201

Sourced-managed docs publication created or reused.

application/json

type: object
required: run, publishAction, publication
properties:
  run (required): Run
    Run:
      type: object
      required: id, projectId, status, createdAt
      properties:
        id (required): string
        orgId: string
        projectId (required): string
        createdByUserId: string
        status (required): string enum queued | running | blocked | complete | ready | failed | expired | canceled
        mode: string enum flagship | stainless_compatible | custom | openapi | stainless | stainless_migration | reference-sample
        verdict: string enum queued | generated | ready | needs_review | not_ready | needs_worker | needs_setup | failed | canceled
        createdAt (required): string
        completedAt: string
        steps: array
          type: array
        inputSummary: object
        notes: string
        currentStep: string
        artifactManifest: ArtifactManifest
          ArtifactManifest:
            type: object
            properties:
              version: integer
              runId: string
              organizationId: string
              projectId: string
              quality: object
              artifacts: array
              expiresAt: string
        updatedAt: string
  publishAction (required): PublishingAction
    PublishingAction:
      type: object
      required: id, runId, registry, action, status, checklist, createdAt
      properties:
        id (required): string
        orgId: string
        projectId: string
        runId (required): string
        registry (required): string enum npm | pypi | docs | github
        action (required): string enum dry_run | publish | rollback | share_preview
        status (required): string enum ready | blocked
        packageName: string
        version: string
        checklist (required): array
          type: array
        providerResult: PublishingProviderResult
          PublishingProviderResult:
            type: object
            properties:
              provider: string enum github | npm | pypi | docs
              mode: string enum dry_run | publish | rollback
              status: string enum ready | blocked
              checkedAt: string
              repository: string
              packageName: string
              summary: string
              checks: array
              target: object
        createdAt (required): string
        updatedAt: string
  publication (required): DocsPreviewShare
    DocsPreviewShare:
      type: object
      required: id, url, noindex, createdAt
      properties:
        id (required): string
        url (required): string
        mode: string enum preview | published
        indexability: string enum noindex_until_policy_approved
        noindex (required): boolean
          Shared preview pages are public but carry `X-Robots-Tag: noindex, nofollow`.
        expiresAt: string
        createdAt (required): string

401

402

403

404

410

The docs-preview artifact expired.

application/json

Error:
  type: object
  required: error
  properties:
    error (required): string
      Stable machine-readable error code.
    message: string
      Optional human-readable description.

422

The run is not ready to publish as a Sourced docs subpath.

application/json

Error:
  type: object
  required: error
  properties:
    error (required): string
      Stable machine-readable error code.
    message: string
      Optional human-readable description.

Back to version index