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

* chore: update openapi docs to include neoforge for forgeUpdates

* chore: add NeoForge parameter to forge_updates
This commit is contained in:
chaos
2025-10-12 16:38:44 +03:00
committed by GitHub
parent 2a61916d1e
commit ea594ec27c

View File

@@ -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
@@ -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: