NLdoc Conversion Event Specification (3.0.32)

Download OpenAPI specification:

NLdoc: info@nldoc.nl URL: https://nldoc.nl/ License: EUPL1.2

This specification provides a standardized way to represent events during a conversion.

queued — https://event.spec.nldoc.nl/queued

type required	string Value: "https://event.spec.nldoc.nl/queued"
timestamp required	string <date-time>
traceId required	string non-empty
context required	object

{"type": "https://event.spec.nldoc.nl/queued",
"timestamp": "2025-03-31T12:54:39Z",
"traceId": "74d30da1-f18d-4aa2-8656-1d3bea92a37c",
"context": { }
}

done — https://event.spec.nldoc.nl/done

type required	string Value: "https://event.spec.nldoc.nl/done"
timestamp required	string <date-time>
traceId required	string non-empty
required	object

{"type": "https://event.spec.nldoc.nl/done",
"timestamp": "2025-03-31T12:54:39Z",
"traceId": "74d30da1-f18d-4aa2-8656-1d3bea92a37c",
"context": {"contentType": "text/html",
"location": "c54cf74d-a79f-498c-a9a9-ee83f0dadf82"
}
}

progress — https://event.spec.nldoc.nl/progress

type required	string Value: "https://event.spec.nldoc.nl/progress"
timestamp required	string <date-time>
traceId required	string non-empty
required	object

{"type": "https://event.spec.nldoc.nl/progress",
"timestamp": "2025-03-31T12:54:39Z",
"traceId": "74d30da1-f18d-4aa2-8656-1d3bea92a37c",
"context": {"subject": "page",
"target": 25,
"position": 5
}
}

error — https://event.spec.nldoc.nl/error

type required	string Value: "https://event.spec.nldoc.nl/error"
timestamp required	string <date-time>
traceId required	string non-empty
required	object

{"type": "https://event.spec.nldoc.nl/error",
"timestamp": "2025-03-31T12:54:39Z",
"traceId": "74d30da1-f18d-4aa2-8656-1d3bea92a37c",
"context": {"code": "invalid_content_type",
"actual": "application/vnd.apple.pages",
"expected": ["application/pdf",
"text/markdown"
]
}
}

invalid_content_type

code required	string Value: "invalid_content_type"
actual required	string non-empty
expected required	Array of strings non-empty [ items non-empty ]

{"code": "invalid_content_type",
"actual": "application/vnd.apple.pages",
"expected": ["application/pdf",
"text/markdown"
]
}

too_many_pages

code required	string Value: "too_many_pages"
actual required	integer
limit required	integer

{"code": "too_many_pages",
"actual": 40,
"limit": 25
}

unexpected

code

required

string

Value: "unexpected"

{"code": "unexpected"
}