Safe Haskell	None
Language	GHC2021

Ecluse.Core.Registry.Maintenance.Protocol

Description

Maintenance through registry protocol endpoints. Deletion needs the raw document revision, with listing bounds separate from serve-path bounds. Consent and refill classification rely on operator configuration.

Synopsis

data ProtocolRead = ProtocolRead {
- prOrigin :: OriginClient
- prListing :: StoreListing
- prCodec :: PublishCodec
- prReadManifest :: StoreManifestRead
- prBackendName :: Text
- prPermitDeletion :: Bool
- prConsentDescriptor :: Text
}
data ProtocolStore = ProtocolStore {
- psRead :: ProtocolRead
- psDeleteOrigin :: OriginClient
- psDelete :: VersionDelete
}
newProtocolObservation :: ProtocolRead -> StoreObservation
newProtocolMaintenance :: ProtocolStore -> StoreMaintenance

Documentation

data ProtocolRead Source #

One protocol-only store as a reader reaches it: where it is, how its protocol enumerates it, and the consent an operator declared for it. Nothing here changes the store.

Constructors

ProtocolRead

Fields

prOrigin :: OriginClient
The store's coordinates, its credential, and the bound every read is held to.
prListing :: StoreListing
The ecosystem's package listing verb.
prCodec :: PublishCodec
The ecosystem's publish codec, whose presence probe already reads a store's version list for the mirror worker.
prReadManifest :: StoreManifestRead
One package's metadata as this store serves it, assembled at the composition root.
prBackendName :: Text
The store backend's name, which the boot line records the Dredger's blast radius as.
prPermitDeletion :: Bool
Whether the operator marked this store for deletion.
prConsentDescriptor :: Text
How an operator marks it, logged verbatim when consent is withheld.

data ProtocolStore Source #

One protocol-only store a caller may delete from: its reads, beside the verb that removes a version.

Constructors

ProtocolStore
Fields psRead :: ProtocolRead psDeleteOrigin :: OriginClient psDelete :: VersionDelete

newProtocolObservation :: ProtocolRead -> StoreObservation Source #

The calls that only enumerate and read, built without the delete verb.

newProtocolMaintenance :: ProtocolStore -> StoreMaintenance Source #

Delete versions individually because each edit changes the document revision needed by the next.