Update 'README.md'

This commit is contained in:
2023-01-30 13:19:22 +01:00
parent a13c8ad8f6
commit 3a1811b65f

View File

@@ -49,7 +49,7 @@ _An automatically generated and interactive API documentation with (live) respon
<details> <details>
<summary>Example response</summary> <summary>Example response</summary>
<p>
```json ```json
{ {
"data": [ "data": [
@@ -68,7 +68,6 @@ _An automatically generated and interactive API documentation with (live) respon
] ]
} }
``` ```
</p>
</details> </details>
**/api/v1/mods/{id}**: Get mod by id **/api/v1/mods/{id}**: Get mod by id
@@ -76,6 +75,9 @@ _An automatically generated and interactive API documentation with (live) respon
- 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]`
<details>
<summary>Example response</summary>
```json ```json
{ {
"data": { "data": {
@@ -86,6 +88,7 @@ _An automatically generated and interactive API documentation with (live) respon
} }
} }
``` ```
</details>
<br/> <br/>
@@ -96,11 +99,50 @@ _An automatically generated and interactive API documentation with (live) respon
- Sort: `version` - Sort: `version`
- Example: `/api/v1/revisions?include=executable,mod&sort[version]` - Example: `/api/v1/revisions?include=executable,mod&sort[version]`
<details>
<summary>Example response</summary>
```json
{
"data": [
{
"id": 7542,
"modId": 426,
"executableId": 8,
"version": "1.19.3"
},
{
"id": 7543,
"modId": 426,
"executableId": 8,
"version": "1.19.2"
}
]
}
```
</details>
**/api/v1/revisions/{id}**: Get revision by id **/api/v1/revisions/{id}**: Get revision by id
- Include: `executable` | `mod` | `executable,mod` - Include: `executable` | `mod` | `executable,mod`
- Sort: `version` - Sort: `version`
- Example: `/api/v1/revisions/1337?include=executable,mod&sort[version]` - Example: `/api/v1/revisions/1337?include=executable,mod&sort[version]`
<details>
<summary>Example response</summary>
```json
{
"data": {
"id": 7556,
"modId": 426,
"executableId": 5,
"version": "1.16"
}
}
```
</details>
<br/> <br/>
##### Executables ##### Executables
@@ -110,11 +152,46 @@ _An automatically generated and interactive API documentation with (live) respon
- Sort: `name` | `key` - Sort: `name` | `key`
- Example: `/api/v1/executables?include=revisions.mod&sort[name]` - Example: `/api/v1/executables?include=revisions.mod&sort[name]`
<details>
<summary>Example response</summary>
```json
{
"data": [
{
"id": 5,
"name": "Java 8",
"key": "JAVA_8"
},
{
"id": 6,
"name": "Java 11",
"key": "JAVA_11"
}
]
}
```
</details>
**/api/v1/executables/{id}**: Get executable by id **/api/v1/executables/{id}**: Get executable by id
- Include: `revisions` | `revisions.mod` - Include: `revisions` | `revisions.mod`
- Sort: `name` | `key` - Sort: `name` | `key`
- Example: `/api/v1/executables/1337?include=revisions.mod&sort[name]` - Example: `/api/v1/executables/1337?include=revisions.mod&sort[name]`
<details>
<summary>Example response</summary>
```json
{
"data": {
"id": 5,
"name": "Java 8",
"key": "JAVA_8"
}
}
```
</details>
<br/> <br/>
## Contributing ## Contributing