Update 'README.md'
This commit is contained in:
28
README.md
28
README.md
@@ -28,19 +28,37 @@
|
||||
|
||||
## Usage
|
||||
|
||||
_An automatically generated and interactive API documentation from existing Laravel routes is available at **/idoc**._
|
||||
_An automatically generated and interactive API documentation with (live) responses is available at **/idoc**._
|
||||
|
||||
** Mods **
|
||||
<br/>
|
||||
|
||||
**Mods**
|
||||
|
||||
/api/v1/mods: Get all mods
|
||||
- Include: `revisions` | `revisions.executable`
|
||||
- Sort: `name` | `projectUrl`
|
||||
- Example: `/api/v1/mods?include=revisions.executable&sort[projectUrl]`
|
||||
|
||||
/api/v1/executables/{id}: Get executable by id
|
||||
- Include: `revisions` | `revisions.mod`
|
||||
/api/v1/mods/{id}: Get mod by id
|
||||
- Include: `revisions` | `revisions.executable`
|
||||
- Sort: `name` | `projectUrl`
|
||||
- Example: `/api/v1/executables/1337?include=revisions.mod&sort[name]`
|
||||
- Example: `/api/v1/mods/1337?include=revisions.executable&sort[projectUrl]`
|
||||
|
||||
<br/>
|
||||
|
||||
**Revisions**
|
||||
|
||||
/api/v1/revisions: Get all revisions
|
||||
- Include: `executable` | `mod` | `executable,mod`
|
||||
- Sort: `version`
|
||||
- Example: `/api/v1/revisions?include=executable,mod&sort[version]`
|
||||
|
||||
/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]`
|
||||
|
||||
<br/>
|
||||
|
||||
**Executables**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user