The Schemas API provides a local schema registry for Devset. You register a schema once — either as a JSON Schema document or a Protobuf definition — and Devset uses it to validate message payloads and deserialize broker messages during workflow simulation and execution. All endpoints are relative to http://localhost:8082.
POST /schemas
Create a new schema. Devset supports two schema types: json for JSON Schema documents and protobuf for Protocol Buffer definitions.
A unique identifier for this schema, such as order-created or payment-processed.
A numeric version for this schema, such as 1 or 2.
The schema format. Accepted values: json, protobuf.
The schema definition. For json, provide a JSON Schema object. For protobuf, provide the raw .proto file content as a string.
Protobuf only. A Base64-encoded FileDescriptorSet binary. Provide this when your .proto file imports other files and you want Devset to resolve them offline.
Protobuf only. The fully-qualified name of the root message type to use for deserialization, such as com.example.OrderCreated.
Request example{
"id": "order-created",
"version": 1,
"type": "json",
"schema": {
"type": "object",
"properties": {
"id": { "type": "string" },
"amount": { "type": "number" },
"status": { "type": "string" }
},
"required": ["id", "amount", "status"]
}
}
Request example{
"id": "order-created-proto",
"version": 1,
"type": "protobuf",
"schema": "syntax = \"proto3\";\npackage com.example;\nmessage OrderCreated {\n string id = 1;\n double amount = 2;\n string status = 3;\n}",
"protobufRootMessage": "com.example.OrderCreated"
}
{
"id": "order-created",
"version": 1,
"type": "json",
"schema": {
"type": "object",
"properties": {
"id": { "type": "string" },
"amount": { "type": "number" },
"status": { "type": "string" }
},
"required": ["id", "amount", "status"]
}
}
The identifier of the newly created schema.
The version number that was stored.
The schema format: json or protobuf.
The stored schema definition.
GET /schemas
List all schemas registered in Devset. The response contains summary information for each schema, including its full definition.
Response — 200 OK
[
{
"id": "order-created",
"version": 1,
"type": "json",
"schema": {
"type": "object",
"properties": {
"id": { "type": "string" }
}
}
},
{
"id": "order-created-proto",
"version": 1,
"type": "protobuf",
"schema": "syntax = \"proto3\"; ...",
"protobufRootMessage": "com.example.OrderCreated"
},
{
"id": "payment-processed",
"version": 2,
"type": "json",
"schema": {}
}
]
The unique schema identifier.
The version number for this schema.
The schema format: json or protobuf.
Protobuf only. The Base64-encoded FileDescriptorSet, if one was provided.
Protobuf only. The fully-qualified root message name, if one was provided.
PUT /schemas/
Replace an existing schema entirely. You must provide the full schema body — partial updates are not supported. Devset overwrites the stored definition and returns the updated schema.
Path parameters
The id of the schema to replace.
Must match the schemaId path parameter.
The updated version number.
The schema format: json or protobuf.
The updated schema definition.
Protobuf only. Updated Base64-encoded FileDescriptorSet.
Protobuf only. Updated root message type name.
{
"id": "order-created",
"version": 2,
"type": "json",
"schema": {
"type": "object",
"properties": {
"id": { "type": "string" },
"amount": { "type": "number" },
"status": { "type": "string" },
"currency": { "type": "string" }
},
"required": ["id", "amount", "status", "currency"]
}
}
{
"id": "order-created",
"version": 2,
"type": "json",
"schema": {
"type": "object",
"properties": {
"id": { "type": "string" },
"amount": { "type": "number" },
"status": { "type": "string" },
"currency": { "type": "string" }
},
"required": ["id", "amount", "status", "currency"]
}
}
DELETE /schemas/
Permanently delete a schema. This cannot be undone.
Path parameters
The id of the schema to delete.
204 No Content response confirms successful deletion.
Deleting a schema that is actively referenced by a workflow stage may cause validation errors the next time that workflow runs. Remove schema references from your workflows before deleting the schema.
