PUBLIC DRAFT — NOT DEPLOYED

LKP-0005: Registry API

Draft design for programmatic interaction with the LKP Registry.

Implementation Status

This document records a proposed registry API design. The public reference implementation does not currently publish /api/v1/register or /api/v1/resources endpoints. The authoritative public registry is available as a human-readable page at /registry/.

CapabilityCurrent public availabilityRecommended path
Browse active specificationsAvailableRegistry or Specifications
Register a resource by APINot deployedDo not submit registration requests to undocumented endpoints.
Query resources by APINot deployedUse the published Registry while the API remains a draft.

1. Abstract

LKP-0005 describes an intended future interface for registering and discovering LKP-compliant resources. The proposal remains a Public Draft and is not a live service contract.

2. Proposed Interface

A future deployment may provide versioned endpoints for registering resources, updating registrations, and querying published records. The paths below are illustrative and must not be treated as available endpoints.

POST /api/v1/register
PUT  /api/v1/register/{id}
GET  /api/v1/resources

Any deployed API must publish stable JSON schemas, authentication requirements, rate limits, privacy handling, and structured error responses before it is announced in the Registry, SDK, or lkp.json manifest.

3. Conditions for Publication

This specification can progress only after the registry service is deployed, documented with real examples, and exposed through the machine-readable manifest. Until then, the public Registry and Specifications index are the canonical discovery surfaces.