Lexicon Garden

at.happyproto.registry.getArtifact

The bytes of a blob the registry has copied, served from its own copy and never redirected to the publisher, so a version stays installable after its publisher deletes it. Name the blob either by version and kind or by its CID. Only blobs that an indexed manifest or publication references are served. The output encoding is `*/*`, as com.atproto.sync.getBlob's is; the media type is the one the blob was published with.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityregistry.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

cid

string · cid

The blob's CID, in place of the other parameters.

did

string · did

The publisher. Required unless cid is given.

index

integer

Which screenshot, counting from 0, when kind is `screenshot`.

  • minimum: 0
  • maximum: 7
  • default: 0

kind

string

Which blob of the version. Required unless cid is given. `icon` is the project's publication icon.

  • knownValues: package | manifest | icon | banner | screenshot

name

string

The project's name, which is the record key of its software.release.project: 1 to 64 lowercase letters, digits and interior hyphens. Required unless cid is given.

  • minLength: 1
  • maxLength: 64

version

string

A semver version without build metadata, with an optional lowercase prerelease, such as `1.2.0` or `1.2.0-beta.1`. Required unless cid is given.

  • minLength: 1
  • maxLength: 64

Output

*/*

Errors

ArtifactNotHeld

The registry does not hold that blob: it has not copied it yet, the version does not have one of that kind, or nothing indexed references it.

NotConfigured

The registry has no identity configured, so it cannot read its own state. An operator problem, not a caller's.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.happyproto.registry.getVersion

    query

    One version of a plugin, by exact version, whatever its lifecycle state or availability.

  • at.happyproto.registry.getRelease

    query

    One release by exact version. Served whatever its status, including `deleted`: that is the left-pad protection the registry exists for.

  • technology.agave.marketplace.getBlob

    query

    The mirror's copy of a published version's archive. The caller verifies the bytes against the CID, as it would the PDS's.

  • at.happyproto.registry.listVersions

    query

    A plugin's versions, most recently indexed first, whatever their lifecycle state.

  • at.happyproto.plugin.release

    record

    One version of a package. The record key is '<slug>:<version>'. A release at a given version is never modified: a registry that later sees a different CID at this key keeps the first and flags the conflict.