Publishing ยท version 0.1.0
Request rollback approval
POST
/api/runs/{runId}/publish/rollbackRequest
curl -X POST 'https://sourced.sh/api/runs/{runId}/publish/rollback' \
-H 'Authorization: Bearer $SOURCED_API_KEY' \
-H 'Content-Type: application/json' \
-d '{}'
const response = await fetch("https://sourced.sh/api/runs/{runId}/publish/rollback", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SOURCED_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const data = await response.json();
import os
import requests
response = requests.request(
"POST",
"https://sourced.sh/api/runs/{runId}/publish/rollback",
headers={"Authorization": f"Bearer {os.environ['SOURCED_API_KEY']}"},
json={},
)
data = response.json()
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
runId | string | Yes | Run identifier. |
Request body
application/json
PublishingActionInput:
type: object
properties:
registry: string enum npm | pypi | docs | github
packageName: string
version: string
notes: string
Responses
202
Rollback request recorded.
application/json
type: object
required: run, publishAction
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