Skip to content

Get Update Information

Experimental

Getting update information returns the latest release identifier, version, and creation timestamp for each of a given set of mods. This is the mechanism by which the Daemon checks whether any installed mod has a newer release available in the registry.

Note: No HTTP endpoint currently exposes this behavior. It is implemented as an internal service method and consumed in tests. A public endpoint is anticipated when the Daemon update-check flow is implemented.

PropertyValue
Applies toWebapp
TriggerCaller provides a list of mod identifiers to check for available updates
PreconditionsNone

Inputs

modIds : String array, required. The identifiers of the mods to check.

Assertions

AssertionStatus
None — unknown mod identifiers are silently omitted from the result

Outputs

{ modId: string; id: string; version: string; createdAt: string }[] : One entry per mod that has at least one public release. Mods with no public releases, or identifiers that do not correspond to any known mod, are omitted from the result. The result may contain fewer entries than the input list.

Effects

None. This is a read-only operation.

Behavior

mermaid
flowchart TD
    Start([findUpdateInformationByIds modIds]) --> Query[modRepository.findUpdateInformationByIds modIds]

    Query --> Done(["Return { modId, id, version, createdAt }[]<br/>for mods with public releases"])

    style Done fill:#4ade80,color:#000

See Also

  • Get latest mod release — Spec page for fetching full release data once an update is detected.
  • Add Release — Spec page for the Daemon behavior that installs a newer release.
  • How the Webapp works — Guide covering release versioning and the versionHash field.
  • Update release — Spec page for how maintainers publish a new version, which changes the versionHash that triggers update detection.