API Reference

Interactive OpenAPI docs are available at http://localhost:8000/docs.

Output Formats

All endpoints that return registry data support the format query parameter:

Value	Content-Type	Description
`json` (default)	`application/json`	Plain JSON object
`jsonld`	`application/ld+json`	JSON-LD with `@context` reference

JSON-LD responses include "@context": "https://celine-eu.github.io/ontologies/celine.jsonld" and use expanded IRIs only.

Read-only endpoints for querying registry data.

List all communities.

Query params: - format — output format (json or jsonld)

Retrieve a single community by its key.

List all members of a community.

Query params: - role — filter by member role (producer, consumer, prosumer) - format — output format

Retrieve a single member.

List all assets belonging to a member.

Query params: - asset_type — filter by asset type

List all assets. Supports filtering:

Query params: - community — filter by community key - member — filter by member ID - asset_type — filter by asset type

List all sites. Supports filtering:

Query params: - community — filter by community key - member — filter by member ID

Endpoints for data management. Protected by the auth/ACL middleware seam (placeholder in current release).

Export the full community graph as a YAML bundle.

Query params: - community (required) — community key to export

Response: application/yaml — v0.4 bundle format (see import / export) section.

Validate a YAML bundle without applying it.

Request: multipart/form-data with file field containing the YAML bundle.

Response: Validation result.

Replace the full community graph from a YAML bundle. Deletes the existing community and all related entities, then recreates from the bundle.

Request: multipart/form-data with file field.

Response: 201 on success.

Health check endpoint. No authentication required. Returns {"status": "ok"}.

Redirects to the CELINE JSON-LD context document.