Packages
arke_server
0.5.2
0.5.2
0.5.1
0.5.0
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-bulk.0
0.3.18
0.3.17
0.3.16
0.3.15
0.3.14
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.1.42
0.1.41
0.1.40
0.1.39
0.1.38
0.1.37
0.1.36
0.1.35
0.1.34
0.1.33
0.1.32
0.1.31
0.1.30
0.1.29
0.1.28
0.1.27
0.1.26
0.1.25
0.1.24
0.1.23
0.1.22
0.1.21
0.1.20
0.1.19
0.1.18
0.1.17
0.1.16
0.1.15
0.1.14
0.1.13
0.1.12
0.1.11
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Arke server
Current section
Files
Jump to
Current section
Files
arke_server
usage-rules.md
usage-rules.md
# Rules for working with ArkeServer
## Understanding ArkeServer
ArkeServer is the Phoenix HTTP/JSON layer of the Arke framework. It exposes the
runtime-defined Arke domain model (Arkes, Units, Parameters, Groups, Links) as
a multi-tenant REST API mounted under the `/lib` prefix: every route translates
an HTTP request into Arke core calls and serializes the result through a single
response envelope. It owns no persistence (that is `arke_postgres`) and no auth
core (that is `arke_auth`/Guardian) — it contributes routing, plug pipelines,
a string filter DSL, OpenAPI specs with SwaggerUI, pluggable client-side OAuth
strategies, and Swoosh mailer hooks.
Four contracts are non-negotiable — never work around them: the `/lib` route
prefix, the `arke-project-key` header, Guardian-only auth, and the
`{"content": ..., "messages": [...]}` response envelope.
Read the topic rules in `usage-rules/` before integrating or extending it.