Get Mod Release

Stable

Getting a mod release returns the full details of a single publicly visible release for a mod, including its assets, symbolic link definitions, and mission scripts.

Property	Value
Applies to	Webapp
Trigger	Client requests `GET /api/mods/:id/releases/:releaseId`
Preconditions	None

Inputs

id : String, required (path parameter). The identifier of the mod.

releaseId : String, required (path parameter). The identifier of the release.

Assertions

Assertion	Status
The release must exist and be publicly visible	Implemented

Outputs

ModReleaseData : Returned with 200 OK when the release is found.

{ code: 404, error: "ReleaseNotFoundError" } : Returned when the release does not exist, is not publicly visible, or the parent mod is not publicly visible.

Effects

None. This is a read-only operation.

Behavior

mermaid

flowchart TD
    Start([GET /api/mods/:id/releases/:releaseId]) --> Query[modRepository.findPublicModRelease id releaseId]

    Query --> Found{Release found<br/>and public?}
    Found -- No --> NotFound(["404 { code: 404, error: 'ReleaseNotFoundError' }"])
    Found -- Yes --> Done([200 ModReleaseData])

    style NotFound fill:#f87171,color:#fff
    style Done fill:#4ade80,color:#000

Get Mod Release ​

Inputs ​

Assertions ​

Outputs ​

Effects ​

Behavior ​