Skip to content

OpenAPI and JSON Schemas

The HTTP API has a machine-readable contract, generated from the same models the service validates with each time these docs are built:

File What it describes
openapi.yaml OpenAPI 3.1: POST /techread/read-with-callback with its multipart body and error bodies, and under webhooks the TechreadMessage POSTed to your callback URL.
schemas/techread-message.json JSON Schema of one callback body. payload_dict is one of the v2 response models, chosen by ask_type.
schemas/read-with-callback-payload.json JSON Schema of the submit's form fields (each is a JSON value in its own part).
schemas/error-response.json JSON Schema of a refusal body.

Generate models with the tool you already use, for example:

1
2
openapi-generator-cli generate -i https://v2.docs.werk24.io/openapi.yaml -g java -o werk24-java
openapi-generator-cli generate -i https://v2.docs.werk24.io/openapi.yaml -g csharp -o werk24-csharp

Postman, Bruno and Insomnia import the file directly.

Keep your parser tolerant

Later versions of this file can add fields and enum values (see the compatibility policy). Configure generated models to ignore unknown properties and to accept unknown enum values, or a new value fails the whole message.

Explorer