Codewerk
openapi examples fill
Walks every media type of responses and request bodies, every parameter with a schema and, if requested, every component schema. Where neither example nor examples exist, a deterministic placeholder is built from the schema: const, default, examples or the first enum value first, then canonical values per type and format (documentation-reserved values: example.com per RFC 2606, 192.0.2.1 per RFC 5737, 2001:db8::1 per RFC 3849, the RFC 9562 sample UUID; dates in 2026), honouring.
POST https://code.halowerk.com/v1/openapi-examples-fillInputs
| Field | Type | Required | Description |
|---|---|---|---|
| spec | See schema | Yes | The OpenAPI 3.0/3.1 document as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected. |
| targets | array | No | Where to add examples. |
| include_optional | boolean | No | Fill optional object properties too. |
| overwrite_invalid | boolean | No | Replace existing examples that violate their schema. |
Show full input schema
{
"type": "object",
"additionalProperties": false,
"required": [
"spec"
],
"properties": {
"spec": {
"description": "The OpenAPI 3.0/3.1 document as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.",
"anyOf": [
{
"type": "object"
},
{
"type": "string",
"minLength": 2,
"maxLength": 2000000
}
]
},
"targets": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string",
"enum": [
"responses",
"request_bodies",
"parameters",
"schemas"
]
},
"default": [
"responses",
"request_bodies",
"parameters"
],
"description": "Where to add examples."
},
"include_optional": {
"type": "boolean",
"default": true,
"description": "Fill optional object properties too."
},
"overwrite_invalid": {
"type": "boolean",
"default": false,
"description": "Replace existing examples that violate their schema."
}
}
}Published input example
{
"spec": {
"openapi": "3.0.3",
"info": {
"title": "Users",
"version": "1"
},
"paths": {
"/users": {
"get": {
"responses": {
"200": {
"description": "ok",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"email"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"email": {
"type": "string",
"format": "email"
}
}
}
}
}
}
}
}
}
}
}
}Result & documentation
Machine-readable documentation of this hub
Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.
More endpoints in this hub
- Codewerk0.003 USDC
action sha pin
POSThttps://code.halowerk.com/v1/action-sha-pinFinds every "uses: owner/repo[/path]@ref" in a GitHub Actions workflow, resolves tags (including annotated tags) and branches to the commit SHA with git ls-remote against github.com, and rewrites the line to "uses: owner/repo[/path]@<sha> #
- Codewerk0.003 USDC
actionlint
POSThttps://code.halowerk.com/v1/actionlintRuns the official statically linked actionlint 1.7.12 release binary (MIT, SHA-256 checked against the published checksums) in an isolated child process without network, with the bundled ShellCheck 0.11.0 for run: scripts (pyflakes is not a
- Codewerk0.004 USDC
api changelog
POSThttps://code.halowerk.com/v1/api-changelogCompares operations, parameters, request bodies, response codes and media types, component schemas (one property level), servers and security schemes of two documents (Swagger 2.0 is converted with swagger2openapi first; 3.0 and 3.1 are rea