Get Mod

Stable

Getting a mod returns the full details of a single publicly visible mod from the registry, along with the resolved profiles of its maintainers.

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

Inputs

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

Assertions

Assertion	Status
The mod must exist and be publicly visible	Implemented

Outputs

{ mod: ModData, maintainers: UserData[] } : Returned with 200 OK when the mod is found. Includes the full mod record and the resolved profile for each maintainer.

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

Effects

None. This is a read-only operation.

Behavior

mermaid

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

    Query --> Found{Mod found<br/>and public?}
    Found -- No --> NotFound(["404 { code: 404, error: 'ModNotFoundError' }"])
    Found -- Yes --> Maintainers[Resolve maintainer profiles]
    Maintainers --> Done(["200 { mod, maintainers }"])

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

Get Mod ​

Inputs ​

Assertions ​

Outputs ​

Effects ​

Behavior ​