Skip to content

V2: Genre & Event API #16

@sylv256

Description

@sylv256

I'm not sure if we need to completely redo this part of the API, but I'm adding this here since it's not currently implemented.

Structure

Genre

{
    "id": "abcde",
    "slug": "mod-garden",
    "metadata": {
        "name": "Mod Garden",
        "description": "A multi-month long event where developers get together to develop a mod within a 2-month timeframe and showcase their mods in a server environment."
    },
    "events": [
        "abcde"
    ]
}

Event

{
    "id": "abcde",
    "slug": "nature",
    "metadata": {
        "name": "Nature",
        "description": "The Yuukaflower Forest National Park is a new and upcoming national park. Built to preserve nature within its purest form."
    },
    "times": {
        "registration_open": "1023",
        "registration_close": "1324",
        "development_start": "1234",
        "development_end": "2345",
        "pack_freeze": "3456"
    },
    "platform": {
        "game": "minecraft",
        "mod_loader": "fabric",
        "game_version": "1.21.5"
    },
    "roles": { // User roles associated with this event.
        "participant": "abcde", // A participant role should be present for an event to be valid.
        "theme_award": "fghij",
        "team_pick_award": "klmno"
    }
}

Endpoints

GET Genres

/genres

GET Genre Slugs or IDs

/genres?with=slug or /genres?with=id

GET Genre by Slug or ID

/genres/{genre_slug} or /genres/{genre_id}?by=id

GET Events

/events/{genre_slug} or /events/{genre_id}?by=id

GET Event Slugs or IDs

/events/{genre_slug}?with=slug or /events/{genre_id}?by=id&with=id

GET Event by ID

/events/{genre_slug}/{event_slug} or /events/{genre_id}/{event_id}?by=id

GET Event submissions

/events/{genre_slug}/{event_slug}/submissions or /events/{genre_id}/{event_id}/submissions?by=id

GET Event submission IDs

/events/{genre_slug}/{event_slug}/submissions?with=id or /events/{genre_id}/{event_id}/submissions?by=id&with=id

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions