diff --git a/README.md b/README.md index 15ec660..419553b 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ _An automatically generated and interactive API documentation with (live) respon
Example response -

+ ```json { "data": [ @@ -68,7 +68,6 @@ _An automatically generated and interactive API documentation with (live) respon ] } ``` -

**/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` - Example: `/api/v1/mods/1337?include=revisions.executable&sort[projectUrl]` +
+Example response + ```json { "data": { @@ -86,6 +88,7 @@ _An automatically generated and interactive API documentation with (live) respon } } ``` +

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