You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sourcelume.apache.org by jg...@apache.org on 2026/10/21 10:18:23 UTC
(sourcelume-site) branch main updated: Registry page: link the OpenAPI document (#7)
This is an automated email from the ASF dual-hosted git repository.
jgoodyear pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sourcelume-site.git
The following commit(s) were added to refs/heads/main by this push:
new 3b40d12 Registry page: link the OpenAPI document (#7)
3b40d12 is described below
commit 3b40d12ae94428e6dbe7ac6105b436b31b6546c9
Author: Achim Nierbeck <AN...@users.noreply.github.com>
AuthorDate: Wed Oct 21 12:18:18 2026 +0200
Registry page: link the OpenAPI document (#7)
Add an API Reference section pointing to docs/openapi.yaml in the
registry repository (the document verified against the code by the
registry build) and to the local /q/openapi and /q/swagger-ui
endpoints. Note that the API Design section below sketches the
intended design, while the OpenAPI document describes what is
implemented today.
Apache-ai: Yes
Generated-by: pi (claude-sonnet-5-5)
Reviewed-by: anierbeck
---
content/pages/registry.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/content/pages/registry.md b/content/pages/registry.md
index 11f22e2..defea12 100644
--- a/content/pages/registry.md
+++ b/content/pages/registry.md
@@ -24,6 +24,22 @@ visit the [Sample](sample.html).
---
+## API Reference
+
+The REST API of the current registry implementation is described by an OpenAPI document that
+is kept in sync with the code:
+
+- **[OpenAPI document (`docs/openapi.yaml`)](https://github.com/apache/sourcelume-registry/blob/main/docs/openapi.yaml)**
+ — the endpoints, request and response schemas, and status codes of the `main` branch.
+- **Interactive documentation** — a locally running registry serves the same document at
+ `/q/openapi` and an interactive Swagger UI at `/q/swagger-ui`
+ (for example `http://localhost:8082/q/swagger-ui`).
+
+The API is still evolving. The *API Design* section below sketches the intended design of
+the registry; the OpenAPI document describes what the registry implements today.
+
+---
+
## High-Level Architecture (Target State)
The Registry serves as the authoritative store for AI training data provenance records. It receives signed attestations from data producers, stores them with full lineage tracking, and exposes them through modern APIs for verification and audit.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@sourcelume.apache.org
For additional commands, e-mail: commits-help@sourcelume.apache.org