product listing
Former-commit-id: 1ee2385fa95125e08311a8e15b7ac4b38c111e26
This commit is contained in:
29
docs/API.md
29
docs/API.md
@@ -10,6 +10,8 @@ automatically every request
|
||||
|
||||
| Type | Route | Queries | Auth? | Notes |
|
||||
| --- | --- | --- | -- | --- |
|
||||
| GET | /api/special/ | | no | |
|
||||
| GET | /api/type/:id | | no | |
|
||||
| GET | /api/search/ | query, page | no | Query endpoint |
|
||||
| GET | /api/bricks/ | query, page | no | Query endpoint |
|
||||
| GET | /api/sets/ | query, page | no | Query endpoint |
|
||||
@@ -47,6 +49,33 @@ brick: brick to search for (absolute)
|
||||
|
||||
set: brick to search for (absolute)
|
||||
|
||||
### /api/special/
|
||||
|
||||
GET /api/special/
|
||||
|
||||
Response Object
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"title": "Special 1",
|
||||
"end": "2020-01-31T00:00:00.000Z",
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### /api/type/:id
|
||||
|
||||
GET /api/type/:id
|
||||
|
||||
Response Object
|
||||
```json
|
||||
{
|
||||
"data": {
|
||||
"type": "brick", // or set
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### /api/search/
|
||||
|
||||
GET /api/search?params
|
||||
|
||||
Reference in New Issue
Block a user