diff options
| author | Adnan Maolood <me@adnano.co> | 2022-07-07 11:38:43 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2022-07-07 17:39:26 +0200 |
| commit | 478d096cf0eaaac2cc4399671725768bf348d2ed (patch) | |
| tree | fbad2ff13580559a83fba8614612a4e8c05a2518 /api.sr.ht | |
| parent | fc898d216b2fcab75c3f214f41676f2a6fb80b75 (diff) | |
| download | sr.ht-docs-478d096cf0eaaac2cc4399671725768bf348d2ed.tar.gz | |
Initial api.sr.ht documentation
Diffstat (limited to 'api.sr.ht')
| -rw-r--r-- | api.sr.ht/index.md | 13 | ||||
| -rw-r--r-- | api.sr.ht/installation.md | 24 |
2 files changed, 37 insertions, 0 deletions
diff --git a/api.sr.ht/index.md b/api.sr.ht/index.md new file mode 100644 index 0000000..53d2265 --- /dev/null +++ b/api.sr.ht/index.md @@ -0,0 +1,13 @@ +--- +title: api.sr.ht docs +--- + +api.sr.ht is the SourceHut GraphQL API gateway. It is responsible for merging +the individual GraphQL APIs of each service into a single federated graph +through GraphQL federation. + +<div class="alert alert-info"> + <strong>Note:</strong> GraphQL federation is still in the process of being + rolled out across sr.ht services. For more information, see + <a href="/ops/federation.md" class="alert-link">the roll-out plan</a>. +</div> diff --git a/api.sr.ht/installation.md b/api.sr.ht/installation.md new file mode 100644 index 0000000..d57ad2e --- /dev/null +++ b/api.sr.ht/installation.md @@ -0,0 +1,24 @@ +--- +title: api.sr.ht Installation +--- + +This document covers the installation steps for api.sr.ht, the GraphQL API +gateway. + +# Installation + +Install the `api.sr.ht` package. + +## Daemons + +- `api.sr.ht` — The GraphQL API gateway + +## Maintenance + +The gateway does not maintain any state except for the federated graph it +constructs by merging the GraphQL APIs of each service. + +If polling is configured, the gateway will periodically poll the GraphQL API of +each service to check for changes to the schema and rebuild the merged schema if +necessary. Otherwise, the gateway will need to be manually restarted to rebuild +the merged schema. |