Include responses in API reference
This commit is contained in:
parent
2c08a08003
commit
9c8fec5fd6
21
README.md
21
README.md
@ -18,6 +18,27 @@ POST /check
|
|||||||
| `product` | `string` | **Required**. The product the license is for |
|
| `product` | `string` | **Required**. The product the license is for |
|
||||||
| `hwid` | `string` | **Required**. The hardware id of the requester |
|
| `hwid` | `string` | **Required**. The hardware id of the requester |
|
||||||
|
|
||||||
|
#### Response
|
||||||
|
|
||||||
|
##### Error
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"error": "Error message"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Success
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"description": "Testing",
|
||||||
|
"ownerSnowflake": 504147739131641857,
|
||||||
|
"ownerName": "Braydon#2712",
|
||||||
|
"duration": -1
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
Loading…
x
Reference in New Issue
Block a user