Get User Mod

Stable

Getting a user mod returns the full details of a single mod owned by the authenticated user. Only maintainers of the mod may retrieve it through this endpoint.

Property	Value
Applies to	Webapp
Trigger	Client requests `GET /api/user-mods/:id`
Preconditions	The user is authenticated and is a maintainer of the mod

Inputs

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

Assertions

Assertion	Status
The user must be authenticated	Implemented
The mod must exist	Implemented
The authenticated user must be a maintainer of the mod	Implemented

Outputs

ModData : Returned with 200 OK when the mod is found and the user is a maintainer.

{ code: 404, error: "ModNotFoundError" | "NotMaintainerError" } : Returned when the mod does not exist or the user is not a maintainer. Both cases return HTTP 404, but the error field in the response body distinguishes "ModNotFoundError" from "NotMaintainerError".

401 Unauthorized : Returned when the session cookie is absent or invalid.

Effects

None. This is a read-only operation.

Behavior

mermaid

flowchart TD
    Start([GET /api/user-mods/:id]) --> Auth{Authenticated?}

    Auth -- No --> Reject401([401 Unauthorized])
    Auth -- Yes --> Exists{Mod exists?}

    Exists -- No --> Reject404A(["404 ModNotFoundError"])
    Exists -- Yes --> IsMaintainer{User is maintainer?}

    IsMaintainer -- No --> Reject404B(["404 NotMaintainerError"])
    IsMaintainer -- Yes --> Done([200 ModData])

    style Reject401 fill:#f87171,color:#fff
    style Reject404A fill:#f87171,color:#fff
    style Reject404B fill:#f87171,color:#fff
    style Done fill:#4ade80,color:#000

Get User Mod ​

Inputs ​

Assertions ​

Outputs ​

Effects ​

Behavior ​