77 lines
1.3 KiB
Markdown
77 lines
1.3 KiB
Markdown
|
# Filters API
|
||
|
|
|
||
|
|
## Get images filter [GET /v3/filter/:provider/images]
|
||
|
|
> Get images filters for provider ':provider'
|
||
|
|
|
||
|
|
### Request
|
||
|
|
* Policy: read_filters
|
||
|
|
* Method: GET
|
||
|
|
* Headers:
|
||
|
|
* Accept: application/json
|
||
|
|
* Params:
|
||
|
|
* :provider - provider id
|
||
|
|
|
||
|
|
### Response
|
||
|
|
**Status: 200**
|
||
|
|
* Headers:
|
||
|
|
* Content-Type: application/json
|
||
|
|
* Body:
|
||
|
|
```json
|
||
|
|
[
|
||
|
|
"image_id"
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Add images to filter [POST /v3/filter/:provider/images/add]
|
||
|
|
> Add images ids to filter for provider ':provider'
|
||
|
|
|
||
|
|
### Request
|
||
|
|
* Policy: edit_filters
|
||
|
|
* Method: POST
|
||
|
|
* Headers:
|
||
|
|
* Accept: application/json
|
||
|
|
* Content-Type: application/json
|
||
|
|
* Params:
|
||
|
|
* :provider - provider id
|
||
|
|
* Body:
|
||
|
|
```json
|
||
|
|
[
|
||
|
|
"image_id"
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
### Response
|
||
|
|
**Status: 200**
|
||
|
|
* Headers:
|
||
|
|
* Content-Type: application/json
|
||
|
|
* Body:
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"images" : [],
|
||
|
|
"message" : "Updated"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Delete image filters [POST /v3/filter/:provider/images/delete]
|
||
|
|
> Delete images ids from filter for provider ':provider'
|
||
|
|
|
||
|
|
### Request
|
||
|
|
* Policy: edit_filters
|
||
|
|
* Method: POST
|
||
|
|
* Headers:
|
||
|
|
* Accept: application/json
|
||
|
|
* Params:
|
||
|
|
* :provider - provider id
|
||
|
|
|
||
|
|
### Response
|
||
|
|
**Status: 200**
|
||
|
|
* Headers:
|
||
|
|
* Content-Type: application/json
|
||
|
|
* Body:
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"images" : [],
|
||
|
|
"message" : "Deleted"
|
||
|
|
}
|
||
|
|
```
|