Skip to content

Commit ea594ec

Browse files
authored
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
1 parent 2a61916 commit ea594ec

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

apps/docs/public/openapi.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3875,6 +3875,13 @@ paths:
38753875
/updates/{id|slug}/forge_updates.json:
38763876
parameters:
38773877
- $ref: '#/components/parameters/ProjectIdentifier'
3878+
- name: neoforge
3879+
in: query
3880+
description: Whether to include NeoForge versions. Can be `only` (NeoForge-only versions), `include` (both Forge and NeoForge versions), or omitted (Forge-only versions).
3881+
schema:
3882+
type: string
3883+
enum: [only, include]
3884+
example: include
38783885
servers:
38793886
- url: https://api.modrinth.com
38803887
description: Production server
@@ -3902,6 +3909,15 @@ paths:
39023909
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`.
39033910
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`,
39043911
the update checker may not function properly.
3912+
3913+
If you're using NeoForge, NeoForge versions will, by default, not appear in the default URL.
3914+
You will need to add `?neoforge=only` to show your NeoForge-only versions, or `?neoforge=include` for both.
3915+
3916+
```toml
3917+
[[mods]]
3918+
# the other stuff here - ID, version, display name, etc.
3919+
updateJSONURL = "https://api.modrinth.com/updates/{slug|ID}/forge_updates.json?neoforge=only"
3920+
```
39053921
tags:
39063922
- misc
39073923
responses:

0 commit comments

Comments
 (0)