Skip to content

chore: update openapi docs to include neoforge for forgeUpdates #4545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 12, 2025
Merged

chore: update openapi docs to include neoforge for forgeUpdates #4545

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55455f3
chore: update openapi docs to include neoforge for forgeUpdates
qtchaos Oct 12, 2025
79d7137
chore: add NeoForge parameter to forge_updates
qtchaos Oct 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions apps/docs/public/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3875,6 +3875,13 @@ paths:
/updates/{id|slug}/forge_updates.json:
parameters:
- $ref: '#/components/parameters/ProjectIdentifier'
- name: neoforge
in: query
description: Whether to include NeoForge versions. Can be `only` (NeoForge-only versions), `include` (both Forge and NeoForge versions), or omitted (Forge-only versions).
schema:
type: string
enum: [only, include]
example: include
servers:
- url: https://api.modrinth.com
description: Production server
Expand Down Expand Up @@ -3902,6 +3909,15 @@ paths:
Make sure that the version format you use for your Modrinth releases is the same as the version format you use in your `mods.toml`.
If you use a format such as `1.2.3-forge` or `1.2.3+1.19` with your Modrinth releases but your `mods.toml` only has `1.2.3`,
the update checker may not function properly.

If you're using NeoForge, NeoForge versions will, by default, not appear in the default URL.
You will need to add `?neoforge=only` to show your NeoForge-only versions, or `?neoforge=include` for both.

```toml
[[mods]]
# the other stuff here - ID, version, display name, etc.
updateJSONURL = "https://api.modrinth.com/updates/{slug|ID}/forge_updates.json?neoforge=only"
```
tags:
- misc
responses:
Expand Down