Update 'README.md'
This commit is contained in:
35
README.md
35
README.md
@@ -47,11 +47,46 @@ _An automatically generated and interactive API documentation with (live) respon
|
|||||||
- Sort: `name` | `projectUrl`
|
- Sort: `name` | `projectUrl`
|
||||||
- Example: `/api/v1/mods?include=revisions.executable&sort[projectUrl]`
|
- Example: `/api/v1/mods?include=revisions.executable&sort[projectUrl]`
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Example response</summary>
|
||||||
|
<p>
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"id": 427,
|
||||||
|
"name": "10 YEARS OF MINECRAFT MAP",
|
||||||
|
"mindRam": 2048,
|
||||||
|
"projectUrl": "https://www.minecraft.net"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 428,
|
||||||
|
"name": "Technic - The 1.7.10 Pack",
|
||||||
|
"mindRam": 4096,
|
||||||
|
"projectUrl": "https://www.technicpack.net/modpack/the-1710-pack.453902"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
</p>
|
||||||
|
</details>
|
||||||
|
|
||||||
**/api/v1/mods/{id}**: Get mod by id
|
**/api/v1/mods/{id}**: Get mod by id
|
||||||
- Include: `revisions` | `revisions.executable`
|
- Include: `revisions` | `revisions.executable`
|
||||||
- Sort: `name` | `projectUrl`
|
- Sort: `name` | `projectUrl`
|
||||||
- Example: `/api/v1/mods/1337?include=revisions.executable&sort[projectUrl]`
|
- Example: `/api/v1/mods/1337?include=revisions.executable&sort[projectUrl]`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"data": {
|
||||||
|
"id": 426,
|
||||||
|
"name": "Minecraft Vanilla",
|
||||||
|
"mindRam": 2048,
|
||||||
|
"projectUrl": "https://www.minecraft.net"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
##### Revisions
|
##### Revisions
|
||||||
|
|||||||
Reference in New Issue
Block a user