DoculaDevelopersDezvoltatori
API 0.8.0 · BuildVersiune produs 0.33.0
Documentation navigationNavigare documentație
POST/api/v1/executions

Submit an idempotent durable execution for an immutable releaseTrimite idempotent o execuție durabilă pentru o versiune imuabilă

Submit an idempotent durable execution for an immutable release. Validates the documented inputs and creates or triggers the canonical outcome. Required inputs: Origin, X-CSRF-Token, Idempotency-Key, request body. HTTP success: 200, 202; documented failures: 401, 403, 404, 405, 409, 415, 422, 500, 503. Reuse the request key only for an exact replay; changed canonical content conflicts.Trimite idempotent o execuție durabilă pentru o versiune imuabilă. Validează intrările documentate și creează sau declanșează rezultatul canonic. Intrări obligatorii: Origin, X-CSRF-Token, Idempotency-Key, request body. Succes HTTP: 200, 202; erori documentate: 401, 403, 404, 405, 409, 415, 422, 500, 503. Refolosește cheia cererii numai pentru o reluare identică; un conținut canonic diferit produce conflict.

Roles: administrator, engineer, operatorRoluri: administrator (administrator), engineer (inginer), operator (operator)Host-local session requiredEste necesară sesiunea hostuluiBody ≤ 1,048,576 bytesBody ≤ 1.048.576 bytes

A session with must_change_password=true is forbidden regardless of role; only session read, password change, and logout remain authorized.O sesiune cu must_change_password=true este interzisă indiferent de rol; rămân autorizate doar citirea sesiunii, schimbarea parolei și deconectarea.

Required headers and parametersHeadere și parametri obligatorii

Content-TypeRequired request headerHeader obligatoriu al cererii
Idempotency-KeyRequired request headerHeader obligatoriu al cererii
OriginRequired request headerHeader obligatoriu al cererii
X-CSRF-TokenRequired request headerHeader obligatoriu al cererii
Originheader · requiredobligatoriu
Must be one configured exact browser origin and its host must equal the request Host; no Referer fallback is accepted.Trebuie să fie una dintre originile exacte configurate pentru browser, iar hostul ei trebuie să coincidă cu Host-ul cererii. Un Referer corespunzător este acceptat numai când Origin lipsește.
http://127.0.0.1:18081
Complete parameter schemaSchema completă a parametrului
{
  "type": "string",
  "format": "uri"
}
X-CSRF-Tokenheader · requiredobligatoriu
Per-session HMAC token returned by login or session-read; it is accepted only with that host's session and exact matching Origin.Token HMAC specific sesiunii, returnat la autentificare sau la citirea sesiunii; este acceptat numai împreună cu sesiunea acelui host și cu un Origin exact corespunzător.
synthetic-csrf-token
Complete parameter schemaSchema completă a parametrului
{
  "type": "string",
  "minLength": 1
}
Idempotency-Keyheader · requiredobligatoriu
Actor-scoped request identity. An exact replay returns the original result; different canonical content conflicts.Identitatea cererii, limitată la actor. O reluare identică returnează rezultatul inițial; un conținut canonic diferit produce conflict.
docs-example-0001
Complete parameter schemaSchema completă a parametrului
{
  "type": "string",
  "minLength": 8,
  "maxLength": 128,
  "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$"
}

Parameter limitsLimitele parametrilor

{"name":"Idempotency-Key","maximum":null,"max_length":128}

Lifecycle and conventionsCiclu și convenții

Open the related API conventionDeschide convenția API asociată

Request examplesExemple de cerere

Synthetic curl · copy onlycurl sintetic · numai pentru copiere
curl --request POST "$DOCULA_URL/api/v1/executions" \
  --cookie "$COOKIE_JAR" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Origin: $DOCULA_URL" \
  --header "X-CSRF-Token: $CSRF_TOKEN" \
  --data-binary @request.json

Request body: requiredBody cerere: obligatoriu

application/json

Structured response bodyBody structurat al răspunsului

Complete request schemaSchema completă a cererii
{
  "$ref": "#/components/schemas/SubmitExecutionRequest",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "release_id",
    "input"
  ],
  "properties": {
    "release_id": {
      "type": "string",
      "format": "uuid"
    },
    "metadata": {
      "$ref": "#/components/schemas/IntakeMetadata",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "schema",
        "source_object",
        "source_timestamp",
        "source_actor",
        "source_system",
        "fixture_family",
        "scenario_id",
        "schedule_interval_months"
      ],
      "properties": {
        "schema": {
          "type": "string",
          "const": "docula-intake-metadata-v1"
        },
        "source_object": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
        },
        "source_timestamp": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "source_actor": {
          "type": "string",
          "pattern": "^[A-Za-z0-9][A-Za-z0-9._:@+-]{0,127}$"
        },
        "source_system": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
        },
        "fixture_family": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
        },
        "scenario_id": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
        },
        "schedule_interval_months": {
          "type": "integer",
          "enum": [
            1,
            6,
            12
          ]
        }
      }
    },
    "input": {
      "x-docula-max-bytes": 524288
    }
  }
}
Synthetic submitExecution request · syntheticExemplu sintetic · application/json
{
  "release_id": "11111111-1111-4111-8111-111111111111",
  "input": "synthetic-example"
}

Responses and failuresRăspunsuri și erori

200The exact actor-scoped idempotent request replayed the original execution without new canonical work.Cererea idempotentă exactă limitată la actor a reluat execuția inițială fără procesare canonică nouă.

Structured response bodyBody structurat al răspunsului

Response headersHeaderele răspunsului

Idempotent-ReplayTrue when the response replays an earlier exact actor-scoped request without new work.True când răspunsul reia o cerere exactă anterioară, limitată la actor, fără procesare nouă.
LocationCanonical resource path for the created or replayed result.Calea canonică a resursei pentru rezultatul creat sau reluat.

application/json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/ExecutionMutation",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "execution",
        "correlation_id",
        "idempotent_replay"
      ],
      "properties": {
        "execution": {
          "$ref": "#/components/schemas/Execution",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "release_id",
            "release_hash",
            "processing_kind",
            "input_hash",
            "raw_input_hash",
            "status",
            "submitted_by",
            "correlation_id",
            "created_at",
            "updated_at",
            "steps",
            "artifacts"
          ],
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "release_id": {
              "type": "string",
              "format": "uuid"
            },
            "release_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "processing_kind": {
              "type": "string",
              "enum": [
                "transformation",
                "document_generation"
              ]
            },
            "submission_id": {
              "type": "string",
              "format": "uuid"
            },
            "processing_node_id": {
              "type": "string",
              "format": "uuid"
            },
            "input": {
              "x-docula-max-bytes": 524288
            },
            "input_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "raw_input": {
              "type": "string",
              "minLength": 1,
              "x-docula-max-bytes": 524288
            },
            "raw_input_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "metadata": {
              "$ref": "#/components/schemas/IntakeMetadata",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "schema",
                "source_object",
                "source_timestamp",
                "source_actor",
                "source_system",
                "fixture_family",
                "scenario_id",
                "schedule_interval_months"
              ],
              "properties": {
                "schema": {
                  "type": "string",
                  "const": "docula-intake-metadata-v1"
                },
                "source_object": {
                  "type": "string",
                  "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
                },
                "source_timestamp": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64
                },
                "source_actor": {
                  "type": "string",
                  "pattern": "^[A-Za-z0-9][A-Za-z0-9._:@+-]{0,127}$"
                },
                "source_system": {
                  "type": "string",
                  "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
                },
                "fixture_family": {
                  "type": "string",
                  "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
                },
                "scenario_id": {
                  "type": "string",
                  "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
                },
                "schedule_interval_months": {
                  "type": "integer",
                  "enum": [
                    1,
                    6,
                    12
                  ]
                }
              }
            },
            "output": {
              "x-docula-max-bytes": 524288
            },
            "output_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "status": {
              "type": "string",
              "enum": [
                "queued",
                "processing",
                "awaiting_compose",
                "completed",
                "failed"
              ]
            },
            "submitted_by": {
              "type": "string",
              "format": "uuid"
            },
            "correlation_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            },
            "created_at": {
              "type": "string",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "format": "date-time"
            },
            "completed_at": {
              "type": "string",
              "format": "date-time"
            },
            "steps": {
              "type": "array",
              "minItems": 2,
              "maxItems": 4,
              "items": {
                "$ref": "#/components/schemas/ExecutionStep",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "name",
                  "position",
                  "status",
                  "attempt",
                  "state_version"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "enum": [
                      "validate",
                      "transform.declarative",
                      "compose",
                      "render"
                    ]
                  },
                  "position": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 4
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "not_started",
                      "queued",
                      "running",
                      "succeeded",
                      "failed"
                    ]
                  },
                  "attempt": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 5
                  },
                  "state_version": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "started_at": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "finished_at": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "duration_ms": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "summary": {
                    "type": "object"
                  },
                  "failure": {
                    "$ref": "#/components/schemas/ExecutionFailure",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "code",
                      "message",
                      "issues"
                    ],
                    "properties": {
                      "code": {
                        "type": "string",
                        "pattern": "^[a-z][a-z0-9_.-]{0,63}$"
                      },
                      "message": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 240
                      },
                      "issues": {
                        "type": "array",
                        "maxItems": 20,
                        "items": {
                          "$ref": "#/components/schemas/ExecutionIssue",
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "path",
                            "message"
                          ],
                          "properties": {
                            "path": {
                              "type": "string",
                              "maxLength": 512
                            },
                            "keyword": {
                              "type": "string",
                              "maxLength": 64
                            },
                            "message": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 240
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "artifacts": {
              "type": "array",
              "maxItems": 2,
              "items": {
                "$ref": "#/components/schemas/ExecutionArtifact",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "kind",
                  "media_type",
                  "byte_size",
                  "content_hash",
                  "created_at"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "kind": {
                    "type": "string",
                    "enum": [
                      "docx",
                      "pdf"
                    ]
                  },
                  "media_type": {
                    "type": "string",
                    "enum": [
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "byte_size": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 26214400
                  },
                  "content_hash": {
                    "type": "string",
                    "pattern": "^[0-9a-f]{64}$"
                  },
                  "created_at": {
                    "type": "string",
                    "format": "date-time"
                  }
                }
              }
            }
          }
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "idempotent_replay": {
          "type": "boolean"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "idempotent_replay": {
          "const": true
        }
      }
    }
  ]
}
Synthetic ExecutionReplay responseExemplu sintetic HTTP 200
{
  "execution": {
    "id": "11111111-1111-4111-8111-000000000001",
    "release_id": "11111111-1111-4111-8111-000000000001",
    "release_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "processing_kind": "transformation",
    "input_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "raw_input_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "status": "queued",
    "submitted_by": "11111111-1111-4111-8111-000000000001",
    "correlation_id": "11111111-1111-4111-8111-000000000001",
    "created_at": "2026-08-01T10:00:00Z",
    "updated_at": "2026-08-01T10:00:00Z",
    "steps": [
      {
        "name": "validate",
        "position": 1,
        "status": "not_started",
        "attempt": 0,
        "state_version": 1
      },
      {
        "name": "transform.declarative",
        "position": 2,
        "status": "queued",
        "attempt": 1,
        "state_version": 2
      }
    ],
    "artifacts": []
  },
  "correlation_id": "11111111-1111-4111-8111-000000000001",
  "idempotent_replay": true
}
202A new canonical execution, ordered steps, audit event, and validate outbox event were stored atomically.O execuție canonică nouă, pașii ordonați, evenimentul de audit și evenimentul validate din outbox au fost stocate atomic.

Structured response bodyBody structurat al răspunsului

Response headersHeaderele răspunsului

LocationCanonical resource path for the created or replayed result.Calea canonică a resursei pentru rezultatul creat sau reluat.

application/json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/ExecutionMutation",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "execution",
        "correlation_id",
        "idempotent_replay"
      ],
      "properties": {
        "execution": {
          "$ref": "#/components/schemas/Execution",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "release_id",
            "release_hash",
            "processing_kind",
            "input_hash",
            "raw_input_hash",
            "status",
            "submitted_by",
            "correlation_id",
            "created_at",
            "updated_at",
            "steps",
            "artifacts"
          ],
          "properties": {
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "release_id": {
              "type": "string",
              "format": "uuid"
            },
            "release_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "processing_kind": {
              "type": "string",
              "enum": [
                "transformation",
                "document_generation"
              ]
            },
            "submission_id": {
              "type": "string",
              "format": "uuid"
            },
            "processing_node_id": {
              "type": "string",
              "format": "uuid"
            },
            "input": {
              "x-docula-max-bytes": 524288
            },
            "input_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "raw_input": {
              "type": "string",
              "minLength": 1,
              "x-docula-max-bytes": 524288
            },
            "raw_input_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "metadata": {
              "$ref": "#/components/schemas/IntakeMetadata",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "schema",
                "source_object",
                "source_timestamp",
                "source_actor",
                "source_system",
                "fixture_family",
                "scenario_id",
                "schedule_interval_months"
              ],
              "properties": {
                "schema": {
                  "type": "string",
                  "const": "docula-intake-metadata-v1"
                },
                "source_object": {
                  "type": "string",
                  "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$"
                },
                "source_timestamp": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64
                },
                "source_actor": {
                  "type": "string",
                  "pattern": "^[A-Za-z0-9][A-Za-z0-9._:@+-]{0,127}$"
                },
                "source_system": {
                  "type": "string",
                  "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
                },
                "fixture_family": {
                  "type": "string",
                  "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
                },
                "scenario_id": {
                  "type": "string",
                  "pattern": "^[a-z0-9][a-z0-9._-]{0,63}$"
                },
                "schedule_interval_months": {
                  "type": "integer",
                  "enum": [
                    1,
                    6,
                    12
                  ]
                }
              }
            },
            "output": {
              "x-docula-max-bytes": 524288
            },
            "output_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "status": {
              "type": "string",
              "enum": [
                "queued",
                "processing",
                "awaiting_compose",
                "completed",
                "failed"
              ]
            },
            "submitted_by": {
              "type": "string",
              "format": "uuid"
            },
            "correlation_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            },
            "created_at": {
              "type": "string",
              "format": "date-time"
            },
            "updated_at": {
              "type": "string",
              "format": "date-time"
            },
            "completed_at": {
              "type": "string",
              "format": "date-time"
            },
            "steps": {
              "type": "array",
              "minItems": 2,
              "maxItems": 4,
              "items": {
                "$ref": "#/components/schemas/ExecutionStep",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "name",
                  "position",
                  "status",
                  "attempt",
                  "state_version"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "enum": [
                      "validate",
                      "transform.declarative",
                      "compose",
                      "render"
                    ]
                  },
                  "position": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 4
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "not_started",
                      "queued",
                      "running",
                      "succeeded",
                      "failed"
                    ]
                  },
                  "attempt": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 5
                  },
                  "state_version": {
                    "type": "integer",
                    "minimum": 1
                  },
                  "started_at": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "finished_at": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "duration_ms": {
                    "type": "integer",
                    "minimum": 0
                  },
                  "summary": {
                    "type": "object"
                  },
                  "failure": {
                    "$ref": "#/components/schemas/ExecutionFailure",
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                      "code",
                      "message",
                      "issues"
                    ],
                    "properties": {
                      "code": {
                        "type": "string",
                        "pattern": "^[a-z][a-z0-9_.-]{0,63}$"
                      },
                      "message": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 240
                      },
                      "issues": {
                        "type": "array",
                        "maxItems": 20,
                        "items": {
                          "$ref": "#/components/schemas/ExecutionIssue",
                          "type": "object",
                          "additionalProperties": false,
                          "required": [
                            "path",
                            "message"
                          ],
                          "properties": {
                            "path": {
                              "type": "string",
                              "maxLength": 512
                            },
                            "keyword": {
                              "type": "string",
                              "maxLength": 64
                            },
                            "message": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 240
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "artifacts": {
              "type": "array",
              "maxItems": 2,
              "items": {
                "$ref": "#/components/schemas/ExecutionArtifact",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "id",
                  "kind",
                  "media_type",
                  "byte_size",
                  "content_hash",
                  "created_at"
                ],
                "properties": {
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "kind": {
                    "type": "string",
                    "enum": [
                      "docx",
                      "pdf"
                    ]
                  },
                  "media_type": {
                    "type": "string",
                    "enum": [
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "byte_size": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 26214400
                  },
                  "content_hash": {
                    "type": "string",
                    "pattern": "^[0-9a-f]{64}$"
                  },
                  "created_at": {
                    "type": "string",
                    "format": "date-time"
                  }
                }
              }
            }
          }
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "idempotent_replay": {
          "type": "boolean"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "idempotent_replay": {
          "const": false
        }
      }
    }
  ]
}
Synthetic ExecutionAccepted responseExemplu sintetic HTTP 202
{
  "execution": {
    "id": "11111111-1111-4111-8111-000000000001",
    "release_id": "11111111-1111-4111-8111-000000000001",
    "release_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "processing_kind": "transformation",
    "input_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "raw_input_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "status": "queued",
    "submitted_by": "11111111-1111-4111-8111-000000000001",
    "correlation_id": "11111111-1111-4111-8111-000000000001",
    "created_at": "2026-08-01T10:00:00Z",
    "updated_at": "2026-08-01T10:00:00Z",
    "steps": [
      {
        "name": "validate",
        "position": 1,
        "status": "not_started",
        "attempt": 0,
        "state_version": 1
      },
      {
        "name": "transform.declarative",
        "position": 2,
        "status": "queued",
        "attempt": 1,
        "state_version": 2
      }
    ],
    "artifacts": []
  },
  "correlation_id": "11111111-1111-4111-8111-000000000001",
  "idempotent_replay": false
}
401A valid server-side session is required.Este necesară o sesiune validă pe server.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 401
        },
        "code": {
          "const": "authentication_required"
        }
      }
    }
  ]
}
Synthetic AuthenticationRequired responseExemplu sintetic HTTP 401
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 401,
  "code": "authentication_required",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
403The session protection failed or the authenticated role cannot mutate this resource.Protecția sesiunii a eșuat sau rolul autentificat nu poate modifica această resursă.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "$ref": "#/components/schemas/MutationProblem",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "correlation_id"
  ],
  "properties": {
    "type": {
      "type": "string",
      "pattern": "^/problems/[a-z_]+$"
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "status": {
      "type": "integer",
      "const": 403
    },
    "code": {
      "type": "string",
      "enum": [
        "csrf_rejected",
        "forbidden"
      ]
    },
    "detail": {
      "type": "string",
      "minLength": 1
    },
    "correlation_id": {
      "type": "string",
      "minLength": 1
    }
  }
}
Synthetic MutationRejected responseExemplu sintetic HTTP 403
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 403,
  "code": "csrf_rejected",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
404The API or health path is unknown.Calea API sau de health este necunoscută.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 404
        },
        "code": {
          "const": "not_found"
        }
      }
    }
  ]
}
Synthetic NotFound responseExemplu sintetic HTTP 404
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 404,
  "code": "not_found",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
405The method is not supported by this path.Metoda nu este acceptată de această cale.

Structured response bodyBody structurat al răspunsului

Response headersHeaderele răspunsului

AllowThe exact method or method set supported by this path.Metoda sau setul exact de metode acceptate de această cale.

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 405
        },
        "code": {
          "const": "method_not_allowed"
        }
      }
    }
  ]
}
Synthetic MethodNotAllowed responseExemplu sintetic HTTP 405
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 405,
  "code": "method_not_allowed",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
409The resource changed before the requested mutation could be applied.Resursa s-a schimbat înainte ca mutația solicitată să poată fi aplicată.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 409
        },
        "code": {
          "const": "conflict"
        }
      }
    }
  ]
}
Synthetic Conflict responseExemplu sintetic HTTP 409
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 409,
  "code": "conflict",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
415The mutation is missing the exact supported JSON content type.Mutației îi lipsește tipul de conținut JSON acceptat exact.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 415
        },
        "code": {
          "const": "unsupported_media_type"
        }
      }
    }
  ]
}
Synthetic UnsupportedMediaType responseExemplu sintetic HTTP 415
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 415,
  "code": "unsupported_media_type",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
422The request is invalid.Cererea este invalidă.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 422
        },
        "code": {
          "const": "validation_failed"
        }
      }
    }
  ]
}
Synthetic ValidationFailed responseExemplu sintetic HTTP 422
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 422,
  "code": "validation_failed",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
500An internal handler failure occurred.A apărut o eroare internă în handler.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 500
        },
        "code": {
          "const": "internal_error"
        }
      }
    }
  ]
}
Synthetic InternalError responseExemplu sintetic HTTP 500
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 500,
  "code": "internal_error",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}
503A required dependency is unavailable.O dependență obligatorie este indisponibilă.

Structured response bodyBody structurat al răspunsului

application/problem+json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "pattern": "^/problems/[a-z_]+$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "status": {
          "type": "integer",
          "minimum": 400,
          "maximum": 599
        },
        "code": {
          "type": "string",
          "enum": [
            "internal_error",
            "dependency_unavailable",
            "invalid_credentials",
            "origin_rejected",
            "validation_failed",
            "rate_limited",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "content_unavailable",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1
        },
        "dependencies": {
          "type": "array",
          "maxItems": 3,
          "items": {
            "$ref": "#/components/schemas/PublicDependency",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "name",
              "status"
            ],
            "properties": {
              "name": {
                "type": "string",
                "enum": [
                  "postgresql",
                  "nats",
                  "s3",
                  "outbox"
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "unavailable"
                ]
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": 503
        },
        "code": {
          "const": "dependency_unavailable"
        }
      }
    }
  ]
}
Synthetic DependencyUnavailable responseExemplu sintetic HTTP 503
{
  "type": "/problems/synthetic_example",
  "title": "synthetic-example",
  "status": 503,
  "code": "dependency_unavailable",
  "detail": "synthetic-example",
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}

Frontend capabilityCapabilitate frontend

Owner: business-ui · /app/configuration/runsResponsabil: business-ui · /app/configuration/runs
PlannedPlanificatNoNuImplementedImplementatYesDaAcceptedAcceptatNoNu

Execution and live-trace workflows are served by the React configuration pages.Operația este folosită de aplicația React de pe ruta indicată.

Guided courseCurs ghidat

This operation is not part of the finite Story 5.3 course.Această operație nu face parte din cursul finit Story 5.3.