Documentation navigationNavigare documentație

POST/api/v1/ingestion-models

Create a revisioned canonical ingestion-model familyCreează o familie revizionată de modele de ingestie

Create a revisioned canonical ingestion-model family. Validates the documented inputs and creates or triggers the canonical outcome. Required inputs: Origin, X-CSRF-Token, Idempotency-Key, request body. HTTP success: 200, 201; documented failures: 401, 403, 405, 409, 415, 422, 500, 503. Reuse the request key only for an exact replay; changed canonical content conflicts.Creează o familie revizionată de modele de ingestie. 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, 201; erori documentate: 401, 403, 405, 409, 415, 422, 500, 503. Refolosește cheia cererii numai pentru o reluare identică; un conținut canonic diferit produce conflict.

Roles: administrator, engineerRoluri: administrator (administrator), engineer (inginer)Host-local session requiredEste necesară sesiunea hostuluiBody ≤ 2,097,152 bytesBody ≤ 2.097.152 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

Request examplesExemple de cerere

Synthetic curl · copy onlycurl sintetic · numai pentru copiere

curl --request POST "$DOCULA_URL/api/v1/ingestion-models" \
  --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/IngestionModelCreateRequest",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "slug",
    "name",
    "definition",
    "contract_version_id",
    "contract_hash"
  ],
  "properties": {
    "slug": {
      "type": "string",
      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$",
      "maxLength": 64
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160
    },
    "description": {
      "type": "string",
      "maxLength": 2000
    },
    "definition": {
      "type": "object"
    },
    "contract_version_id": {
      "type": "string",
      "format": "uuid"
    },
    "contract_hash": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    }
  }
}

Synthetic createIngestionModel request · syntheticExemplu sintetic · application/json

{
  "slug": "synthetic-example",
  "name": "synthetic-example",
  "definition": {},
  "contract_version_id": "11111111-1111-4111-8111-111111111111",
  "contract_hash": "0000000000000000000000000000000000000000000000000000000000000000"
}

Responses and failuresRăspunsuri și erori

200A committed canonical definition mutation, cancellation, or exact actor-scoped replay.O mutație ori anulare confirmată a definiției canonice sau o reluare exactă limitată la actor.

Structured response bodyBody structurat al răspunsului

application/json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului

{
  "$ref": "#/components/schemas/ConfigurationMutationResult",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "resource_kind",
    "resource_id",
    "result",
    "response_hash",
    "idempotent_replay",
    "correlation_id"
  ],
  "properties": {
    "resource_kind": {
      "type": "string",
      "enum": [
        "activation",
        "ingestion_model",
        "transformer",
        "template"
      ]
    },
    "resource_id": {
      "type": "string",
      "format": "uuid"
    },
    "result": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ConfigurationPublicationOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "family_id",
            "family_slug",
            "version_id",
            "version",
            "content_hash",
            "activation_id",
            "effective_from",
            "scheduled_at"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "family_id": {
              "type": "string",
              "format": "uuid"
            },
            "family_slug": {
              "type": "string"
            },
            "version_id": {
              "type": "string",
              "format": "uuid"
            },
            "version": {
              "type": "integer",
              "minimum": 1
            },
            "content_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "activation_id": {
              "type": "string",
              "format": "uuid"
            },
            "effective_from": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "scheduled_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            }
          }
        },
        {
          "$ref": "#/components/schemas/ConfigurationCancellationOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "activation_id",
            "kind",
            "family_id",
            "version_id",
            "effective_from",
            "cancelled_at",
            "cancellation_code"
          ],
          "properties": {
            "activation_id": {
              "type": "string",
              "format": "uuid"
            },
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "family_id": {
              "type": "string",
              "format": "uuid"
            },
            "version_id": {
              "type": "string",
              "format": "uuid"
            },
            "effective_from": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "cancelled_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "cancellation_code": {
              "type": "string",
              "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$"
            }
          }
        },
        {
          "$ref": "#/components/schemas/ConfigurationDefinitionFamilyOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "id",
            "slug",
            "name",
            "description",
            "draft_revision",
            "created_at",
            "updated_at"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "slug": {
              "type": "string",
              "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "draft_revision": {
              "type": "integer",
              "minimum": 0
            },
            "created_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "updated_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            }
          }
        },
        {
          "$ref": "#/components/schemas/ConfigurationDefinitionVersionOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "id",
            "family_id",
            "number",
            "content_hash",
            "source_revision",
            "status",
            "created_at",
            "reused"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "family_id": {
              "type": "string",
              "format": "uuid"
            },
            "number": {
              "type": "integer",
              "minimum": 1
            },
            "content_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "source_revision": {
              "type": "integer",
              "minimum": 1
            },
            "status": {
              "type": "string",
              "enum": [
                "versioned",
                "published"
              ]
            },
            "created_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "reused": {
              "type": "boolean"
            }
          }
        }
      ]
    },
    "response_hash": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    },
    "idempotent_replay": {
      "type": "boolean"
    },
    "correlation_id": {
      "type": "string",
      "minLength": 1
    }
  }
}

Synthetic ConfigurationMutationOK responseExemplu sintetic HTTP 200

{
  "resource_kind": "activation",
  "resource_id": "11111111-1111-4111-8111-000000000001",
  "result": {
    "kind": "ingestion_model",
    "family_id": "11111111-1111-4111-8111-000000000001",
    "family_slug": "synthetic-example",
    "version_id": "11111111-1111-4111-8111-000000000001",
    "version": 1,
    "content_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "activation_id": "11111111-1111-4111-8111-000000000001",
    "effective_from": "2026-08-01T10:00:00Z",
    "scheduled_at": "2026-08-01T10:00:00Z"
  },
  "response_hash": "0000000000000000000000000000000000000000000000000000000000000000",
  "idempotent_replay": false,
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}

201A canonical family, immutable version, or future activation was atomically created.O familie canonică, o versiune imuabilă sau o activare viitoare a fost creată atomic.

Structured response bodyBody structurat al răspunsului

application/json

Structured response bodyBody structurat al răspunsului

Complete response schemaSchema completă a răspunsului

{
  "$ref": "#/components/schemas/ConfigurationMutationResult",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "resource_kind",
    "resource_id",
    "result",
    "response_hash",
    "idempotent_replay",
    "correlation_id"
  ],
  "properties": {
    "resource_kind": {
      "type": "string",
      "enum": [
        "activation",
        "ingestion_model",
        "transformer",
        "template"
      ]
    },
    "resource_id": {
      "type": "string",
      "format": "uuid"
    },
    "result": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ConfigurationPublicationOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "family_id",
            "family_slug",
            "version_id",
            "version",
            "content_hash",
            "activation_id",
            "effective_from",
            "scheduled_at"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "family_id": {
              "type": "string",
              "format": "uuid"
            },
            "family_slug": {
              "type": "string"
            },
            "version_id": {
              "type": "string",
              "format": "uuid"
            },
            "version": {
              "type": "integer",
              "minimum": 1
            },
            "content_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "activation_id": {
              "type": "string",
              "format": "uuid"
            },
            "effective_from": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "scheduled_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            }
          }
        },
        {
          "$ref": "#/components/schemas/ConfigurationCancellationOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "activation_id",
            "kind",
            "family_id",
            "version_id",
            "effective_from",
            "cancelled_at",
            "cancellation_code"
          ],
          "properties": {
            "activation_id": {
              "type": "string",
              "format": "uuid"
            },
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "family_id": {
              "type": "string",
              "format": "uuid"
            },
            "version_id": {
              "type": "string",
              "format": "uuid"
            },
            "effective_from": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "cancelled_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "cancellation_code": {
              "type": "string",
              "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$"
            }
          }
        },
        {
          "$ref": "#/components/schemas/ConfigurationDefinitionFamilyOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "id",
            "slug",
            "name",
            "description",
            "draft_revision",
            "created_at",
            "updated_at"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "slug": {
              "type": "string",
              "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "draft_revision": {
              "type": "integer",
              "minimum": 0
            },
            "created_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "updated_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            }
          }
        },
        {
          "$ref": "#/components/schemas/ConfigurationDefinitionVersionOutcome",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "kind",
            "id",
            "family_id",
            "number",
            "content_hash",
            "source_revision",
            "status",
            "created_at",
            "reused"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "ingestion_model",
                "transformer",
                "template"
              ]
            },
            "id": {
              "type": "string",
              "format": "uuid"
            },
            "family_id": {
              "type": "string",
              "format": "uuid"
            },
            "number": {
              "type": "integer",
              "minimum": 1
            },
            "content_hash": {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            "source_revision": {
              "type": "integer",
              "minimum": 1
            },
            "status": {
              "type": "string",
              "enum": [
                "versioned",
                "published"
              ]
            },
            "created_at": {
              "$ref": "#/components/schemas/CanonicalTimestamp",
              "type": "string",
              "format": "date-time",
              "description": "UTC timestamp serialized with RFC3339Nano precision."
            },
            "reused": {
              "type": "boolean"
            }
          }
        }
      ]
    },
    "response_hash": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    },
    "idempotent_replay": {
      "type": "boolean"
    },
    "correlation_id": {
      "type": "string",
      "minLength": 1
    }
  }
}

Synthetic ConfigurationMutationCreated responseExemplu sintetic HTTP 201

{
  "resource_kind": "activation",
  "resource_id": "11111111-1111-4111-8111-000000000001",
  "result": {
    "kind": "ingestion_model",
    "family_id": "11111111-1111-4111-8111-000000000001",
    "family_slug": "synthetic-example",
    "version_id": "11111111-1111-4111-8111-000000000001",
    "version": 1,
    "content_hash": "0000000000000000000000000000000000000000000000000000000000000000",
    "activation_id": "11111111-1111-4111-8111-000000000001",
    "effective_from": "2026-08-01T10:00:00Z",
    "scheduled_at": "2026-08-01T10:00:00Z"
  },
  "response_hash": "0000000000000000000000000000000000000000000000000000000000000000",
  "idempotent_replay": false,
  "correlation_id": "11111111-1111-4111-8111-000000000001"
}

401A valid session is required.Este necesară o sesiune validă.

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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 401
        },
        "code": {
          "const": "authentication_required"
        }
      }
    }
  ]
}

Synthetic ConfigurationAuthenticationRequired 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

403The current role cannot access configuration, or same-origin CSRF protection rejected a mutation.Rolul curent nu poate accesa configurarea sau protecția CSRF same-origin a respins o mutație.

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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 403
        },
        "code": {
          "enum": [
            "csrf_rejected",
            "forbidden"
          ]
        }
      }
    }
  ]
}

Synthetic ConfigurationForbidden 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

405The method is not supported by this canonical path.Metoda nu este acceptată de această cale canonică.

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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 405
        },
        "code": {
          "const": "method_not_allowed"
        }
      }
    }
  ]
}

Synthetic ConfigurationMethodNotAllowed 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

409The mutation conflicts with canonical state or prior idempotent content.Mutația intră în conflict cu starea canonică sau cu un conținut idempotent anterior.

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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 409
        },
        "code": {
          "const": "conflict"
        }
      }
    }
  ]
}

Synthetic ConfigurationConflict 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

415Content-Type must be application/json.Content-Type trebuie să fie application/json.

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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 415
        },
        "code": {
          "const": "unsupported_media_type"
        }
      }
    }
  ]
}

Synthetic ConfigurationUnsupportedMediaType 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

422The request, query, header, or canonical configuration is invalid.Cererea, query-ul, headerul sau configurarea canonică 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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 422
        },
        "code": {
          "const": "validation_failed"
        }
      }
    }
  ]
}

Synthetic ConfigurationValidationFailed 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

500Canonical configuration failed safely.Configurarea canonică a eșuat în siguranță.

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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 500
        },
        "code": {
          "const": "internal_error"
        }
      }
    }
  ]
}

Synthetic ConfigurationInternalError 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

503A canonical configuration dependency is unavailable or returned unsafe evidence.O dependență a configurării canonice este indisponibilă sau a returnat dovezi nesigure.

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/ConfigurationProblem",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "type",
        "title",
        "status",
        "code",
        "detail",
        "correlation_id",
        "errors"
      ],
      "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",
            "authentication_required",
            "csrf_rejected",
            "forbidden",
            "conflict",
            "not_found",
            "method_not_allowed",
            "unsupported_media_type",
            "validation_failed",
            "precondition_required",
            "precondition_failed"
          ]
        },
        "detail": {
          "type": "string",
          "minLength": 1
        },
        "correlation_id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "errors": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "$ref": "#/components/schemas/ConfigurationIssue",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "code",
              "stage",
              "resource_kind",
              "message",
              "correlation_id"
            ],
            "properties": {
              "code": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "stage": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_kind": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "resource_id": {
                "type": "string",
                "maxLength": 128
              },
              "path": {
                "type": "string",
                "maxLength": 512
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 512
              },
              "dependency": {
                "type": "string",
                "maxLength": 64,
                "pattern": "^[a-z][a-z0-9_.:-]{0,63}$"
              },
              "context": {
                "type": "object",
                "maxProperties": 16,
                "additionalProperties": {
                  "type": "string",
                  "maxLength": 256
                }
              },
              "correlation_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              }
            }
          }
        }
      }
    },
    {
      "properties": {
        "status": {
          "const": 503
        },
        "code": {
          "const": "dependency_unavailable"
        }
      }
    }
  ]
}

Synthetic ConfigurationDependencyUnavailable 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",
  "errors": [
    {
      "code": "synthetic-example",
      "stage": "synthetic-example",
      "resource_kind": "synthetic-example",
      "message": "synthetic-example",
      "correlation_id": "11111111-1111-4111-8111-000000000001"
    }
  ]
}

Frontend capabilityCapabilitate frontend

API-onlyDoar API

PlannedPlanificatNoNuImplementedImplementatNoNuAcceptedAcceptatNoNu

Ingestion-model workflows are API-only; see the operational tasks guide.Operația rămâne intenționat disponibilă doar prin API.

Required headers and parametersHeadere și parametri obligatorii

Parameter limitsLimitele parametrilor

Lifecycle and conventionsCiclu și convenții

Request examplesExemple de cerere

application/json

Responses and failuresRăspunsuri și erori

application/json

application/json

application/problem+json

application/problem+json

Response headersHeaderele răspunsului

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

Frontend capabilityCapabilitate frontend

Guided courseCurs ghidat