api

API Examples

This directory contains concrete JSON payloads for the validator HTTP surface.

Included examples

• validate-request.single.json Single-capsule request envelope.
• validate-request.batch.json Batch request envelope with mixed validity inputs.
• validate-response.pass.json Positive single-capsule response.
• validate-response.fail.json Negative single-capsule response that isolates G16.
• validate-response.batch.json Mixed batch response sample.
• validate-request.fix.json Fix-route request envelope using the public negative G16 example.
• validate-response.fix.sample.json Illustrative fix-route response showing the corrected capsule payload.
• gates-response.sample.json Small response example for the gate-definition route.
• stats-response.sample.json Small response example for validator statistics.
• stats-error-response.sample.json Small bounded failure example for the documented GET /api/validate/stats 500 status.
• error-response.sample.json Shared generic error envelope.
• unauthorized-response.sample.json Small unauthorized example for a bounded access rejection.
• forbidden-response.sample.json Small owner-role rejection example for the documented 403 route status.
• conflict-response.sample.json Small conflict example for a bounded state rejection.
• rate-limit-response.sample.json Shared rate-limit envelope.

Usage

Use these files to:

• understand validator request and response envelopes quickly
• prototype integrations without opening the full private runtime repo
• test serializers and API clients against public-safe payloads
• compare direct validation, batch validation, and fix-route shapes side by side

The example set is schema-covered by ../../schemas/validator-api-envelopes.schema.json.

Intentionally schema-invalid validator-envelope fixtures live in the sibling directory ../api-invalid/. Those files are for raw-schema rejection tests, not for structurally valid route examples.

The bounded map of how these payloads relate to capsule examples and public review surfaces lives in ../../PUBLIC_EXAMPLE_COVERAGE.json.