PUBLIC DRAFT — NOT DEPLOYED

LKP-0004: Validator API

Draft design for programmatic access to LKP compliance validation.

Implementation Status

This document records a proposed API design. No public /api/v1/validate endpoint is deployed by the reference implementation at this time. Integrations should use the web validator for interactive checks or the LKP-SDK CLI for local and CI/CD validation.

CapabilityCurrent public availabilityRecommended path
Interactive validationAvailableWeb Validator
Automated local validationAvailableLKP-SDK CLI
HTTP Validator APINot deployedDo not depend on an endpoint until a stable announcement is published.

1. Abstract

LKP-0004 defines the intended shape of a future Validator API for systems that need programmatic validation of public web resources. The draft is retained for review and implementation planning; it is not a live service contract.

2. Proposed Interface

A future implementation may expose a versioned endpoint for submitting a fully qualified public URL and receiving structured results. The proposal below is informative only and does not imply endpoint availability.

POST /api/v1/validate
Content-Type: application/json

{
  "url": "https://example.com/",
  "level": 4
}

Any deployed API must validate URL syntax, reject local and private network targets, apply strict request limits, return JSON errors consistently, and document its authentication model before it is listed as active in the Registry or manifest.

3. Conditions for Publication

This specification can move beyond Public Draft only when the endpoint is deployed, versioned, documented with real response examples, protected against unsafe remote requests, and linked from the machine-readable manifest. Until then, the web validator and CLI are the authoritative implementation paths.