mirror of
https://github.com/YGGverse/YGGo.git
synced 2025-01-08 22:07:56 +00:00
update readme
This commit is contained in:
parent
14ba97f46a
commit
1c4904d333
10
README.md
10
README.md
@ -74,21 +74,21 @@ Could be enabled or disabled by `API_SEARCH_ENABLED` option
|
|||||||
###### Request attributes
|
###### Request attributes
|
||||||
|
|
||||||
```
|
```
|
||||||
GET action=search
|
GET action=search - required
|
||||||
GET query={string} - search request, empty if not provided
|
GET query={string} - optional, search request, empty if not provided
|
||||||
GET page={int} - search results page, 1 if not provided
|
GET page={int} - optional, search results page, 1 if not provided
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Hosts distribution API
|
##### Hosts distribution API
|
||||||
|
|
||||||
Returns node hosts collected with fields provided in `API_HOSTS_FIELDS` settings.
|
Returns node hosts collected with fields provided in `API_HOSTS_FIELDS` option.
|
||||||
|
|
||||||
Could be enabled or disabled by `API_HOSTS_ENABLED` option
|
Could be enabled or disabled by `API_HOSTS_ENABLED` option
|
||||||
|
|
||||||
###### Request attributes
|
###### Request attributes
|
||||||
|
|
||||||
```
|
```
|
||||||
GET action=hosts
|
GET action=hosts - required
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Roadmap / ideas
|
#### Roadmap / ideas
|
||||||
|
Loading…
Reference in New Issue
Block a user