specification published #334

New issue

Open

opened 2025-05-15 20:14:11 +02:00 by kiara · 0 comments

kiara commented

2025-05-15 20:14:11 +02:00

Owner

As a front-end developer,
I want an (API) spec describing how to interact with Fediversity,
so that I can start work on front-ends.

implementation notes

see #195 for JSON-schema needed for a potential openapi spec
this schema should be the (Git-ignored) ./src/panel/configuration/schema.json from #351 (example), which given the ignore could be published using a CI pipeline
note that there will be some discrepancies between our NixOS configuration input variables versus the operator-specific deployment configurations in a multi-tenancy setting (#313) like panel, notably global run-time configurations such as ProxmoX configuration

**As** a front-end developer, **I want** an (API) spec describing how to interact with Fediversity, **so that** I can start work on front-ends. ## implementation notes - see #195 for JSON-schema needed for a potential openapi spec - this schema should be the (Git-ignored) `./src/panel/configuration/schema.json` from #351 ([example](https://git.fediversity.eu/kiara/fedi-goals/commit/6e385a527db6088bb6365d8682156600563edec7)), which given the ignore could be published using a CI pipeline - note that there will be some discrepancies between our NixOS configuration input variables versus the operator-specific deployment configurations in a multi-tenancy setting (#313) like `panel`, notably global run-time configurations such as ProxmoX configuration