Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.Adapter.Types

Contents

The capability record
The serve surface

Description

The capability record an ecosystem registers (RegistryAdapter) and the serve surface it carries. A record holds no URL, credential, limit, or policy: it is a static fact of the build. It sits apart from the registration (Ecluse.Core.Registry.Adapter) as the cycle-breaking .Types split of docs/style.md 4.3, so an adapter module never imports that registry. The embedded slices live in Ecluse.Core.Registry.Adapter.Capability.

Synopsis

The capability record

data RegistryAdapter Source #

One ecosystem's complete capability record, which the composition root wires every consuming pipeline from. adapterFor resolves it.

Constructors

RegistryAdapter

Fields

adapterEcosystem :: Ecosystem
The registry key must agree with it, so no record can register under a foreign ecosystem.
adapterServe :: AdapterServe
The web-facing serve surface: the route grammar and response contracts.
adapterMetadata :: AdapterMetadata
The metadata capability: the read-handle constructor and the packument assembly.
adapterArtifact :: AdapterArtifact
The artifact request formation, by filename and by authoritative URL.
adapterProjectName :: ProjectName
The ecosystem's own name parser, which every caller that turns a raw string into a PackageName reads.
adapterPublish :: Maybe AdapterPublish
Nothing for an ecosystem this build writes nothing for, whose publish route then answers 405 and whose declared write destination refuses the boot.
adapterMaintenance :: AdapterMaintenance
The store maintenance verbs. Either may be absent, and a Dredger then refuses the mount.

The serve surface

data AdapterServe Source #

The ecosystem's web-facing serve surface. Both routing fields are derived from one declarative route table, so the routed surface and the documented one cannot drift apart.

Constructors

AdapterServe

Fields

serveRouter :: MountRouter
Which path a mount-relative request names. An unrecognised one yields the default 404.
serveRoutes :: NonEmpty RouteSpec
The same route table as data, which the OpenAPI spec (Ecluse.Manifest) renders.
serveCredential :: CredentialMapping
How the mount recovers a client's credential and how Écluse carries one upstream. The neutral pipeline spells no scheme of its own.