Skip to content
HALOWERK

Codewerk

contract test own api

One to three same-origin public HTTPS JSON GET tests after purpose-bound DNS TXT authorization. Compares HTTP status and a deterministic bounded JSON Schema subset; returns ordered pass/fail issues, timings and raw-response hashes, never response bodies. No arbitrary scanner, query, credentials, headers, redirects, external schema refs, regex, plugins or execution.

POST https://code.halowerk.com/v1/contract-test-own-api

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
ownership_secretstringYesTXT at _halowerk-contract.<hostname>: halowerk-contract-v1=SHA256(HALOWERK-CONTRACT-V1+LF+GET+LF+origin+LF+sorted canonical URLs joined with LF+LF+SHA256(secret)). UTF-8, lowercase hex, no trailing LF. Secret is private; example is public demo for two own info paths.
testsarrayYesDistinct same-origin exact read-only JSON GET URLs and expectations.
timeout_msintegerNoNetwork timeout for each target HTTP fetch.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "ownership_secret",
    "tests"
  ],
  "properties": {
    "ownership_secret": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{43,128}$",
      "description": "TXT at _halowerk-contract.<hostname>: halowerk-contract-v1=SHA256(HALOWERK-CONTRACT-V1+LF+GET+LF+origin+LF+sorted canonical URLs joined with LF+LF+SHA256(secret)). UTF-8, lowercase hex, no trailing LF. Secret is private; example is public demo for two own info paths."
    },
    "tests": {
      "type": "array",
      "minItems": 1,
      "maxItems": 3,
      "description": "Distinct same-origin exact read-only JSON GET URLs and expectations.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "url",
          "schema"
        ],
        "properties": {
          "url": {
            "type": "string",
            "maxLength": 1200,
            "description": "Canonical public DNS HTTPS443 URL without query or fragment."
          },
          "expected_status": {
            "type": "integer",
            "minimum": 200,
            "maximum": 599,
            "default": 200,
            "description": "Expected HTTP status; response must still be JSON."
          },
          "schema": {
            "type": "object",
            "description": "Bounded JSON Schema subset: required type, primitive enum, object properties/required/additionalProperties, array items/bounds, string length, number bounds. No refs/regex/extensions."
          }
        }
      }
    },
    "timeout_ms": {
      "type": "integer",
      "minimum": 250,
      "maximum": 2500,
      "default": 2500,
      "description": "Network timeout for each target HTTP fetch."
    }
  }
}

Open original schema

Published input example

{
  "ownership_secret": "halowerk-public-demo-contract-health-readiness-v1-20261115",
  "tests": [
    {
      "url": "https://code.halowerk.com/health",
      "expected_status": 200,
      "schema": {
        "type": "object",
        "required": [
          "status",
          "endpoints"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "ok"
            ]
          },
          "endpoints": {
            "type": "integer",
            "minimum": 1
          }
        },
        "additionalProperties": true
      }
    },
    {
      "url": "https://code.halowerk.com/readiness",
      "expected_status": 200,
      "schema": {
        "type": "object",
        "required": [
          "ready",
          "settlement"
        ],
        "properties": {
          "ready": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "settlement": {
            "type": "string",
            "enum": [
              "ok"
            ]
          }
        },
        "additionalProperties": true
      }
    }
  ]
}

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

All endpoints in this hub โ†’