Skip to content
Proud to collaborate with Microsoft for Startups

aria.publish ​

Validate a hosted service's draft and publish it as an immutable revision.

Freeze the draft into a servable revision.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-aria
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
slugstringYes——
acknowledge_breakingbooleanNo—Required when the new revision renames or removes a tool: clients cache the catalogue when the connector is added and keep calling the old name.

Output Schema ​

FieldTypeRequiredDefaultDescription
servicejsonNo——
revisionintegerNo——
endpointstringNo——
diffjsonNo——
breakingbooleanNo——
violationslistNo—Why the publish was refused, one entry per problem
dropped_typeslistNo——
failure_reasonstringNo——
failed_at_statestringNo——
failed_stepjsonNo——
failed_layerintegerNo——
errorstringNo——
error_typestringNo——
failed_atstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
publishedSUCCESSA new revision is being servedrevision, endpoint
failedFAILUREThe action was refused or failedfailure_reason

Business Errors ​

CodeMessage Template
ARIA_SERVICE_NOT_FOUNDNo such service in this organization
ARIA_REFUSEDThe action was refused
ARIA_REFUSEDThe action was refused

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "aria.publish",
  "initial_data": {
    "slug": "value"
  }
}