Browse Mods

Stable

Browsing mods returns a paginated list of publicly visible mods from the registry, optionally filtered by category, tags, maintainer, or a search term. The response includes the page metadata and the set of filter values available for the current result.

Property	Value
Applies to	Webapp
Trigger	Client requests `GET /api/mods` with optional filter params
Preconditions	None

Inputs

page : Number, required. The page number to return, 1-indexed (the first page is 1).

size : Number, required. The number of results per page.

category : Enum, optional. Filters results to mods in the given category. One of CAMPAIGN, DEVICE_PROFILES, MOD, MISSION, SKIN, SOUND, TERRAIN, UTILITY, or OTHER.

maintainers : Comma-separated string, optional. Filters results to mods maintained by the given user identifiers.

tags : Comma-separated string, optional. Filters results to mods carrying all of the given tags.

term : String, optional. Free-text search term matched against mod names and descriptions.

Assertions

Assertion	Status
None — all filter parameters are optional; omitting all returns all public mods

Outputs

{ data: ModSummaryData[], page: PageData, filter: ModAvailableFilterData } : On success:

data : The list of mod summaries for the current page.

page : Pagination metadata: number, size, totalPages, and totalElements.

filter : The available filter values for the current result set: categories, maintainers, and tags.

Effects

None. This is a read-only operation.

Behavior

mermaid

flowchart TD
    Start(["GET /api/mods?page&size&category&maintainers&tags&term"]) --> Query[modRepository.findAllPublishedMods with filter]
    Query --> Maintainers[Resolve maintainer profiles<br/>for results]
    Maintainers --> Build[Build page and filter metadata]
    Build --> Done(["{ data, page, filter }"])

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

Browse Mods ​

Inputs ​

Assertions ​

Outputs ​

Effects ​

Behavior ​