refactor: rename blacklist to blocklist (#2157)
Signed-off-by: 0xsysr3ll <0xsysr3ll@pm.me> Co-authored-by: fallenbagel <98979876+Fallenbagel@users.noreply.github.com> Co-authored-by: 0xsysr3ll <0xsysr3ll@pm.me> Co-authored-by: gauthier-th <mail@gauthierth.fr>
This commit is contained in:
Conlan Kreher
160
seerr-api.yml
160
seerr-api.yml
@@ -38,8 +38,8 @@ tags:
|
||||
description: Endpoints related to getting service (Radarr/Sonarr) details.
|
||||
- name: watchlist
|
||||
description: Collection of media to watch later
|
||||
- name: blacklist
|
||||
description: Blacklisted media from discovery page.
|
||||
- name: blocklist
|
||||
description: Blocklisted media from discovery page.
|
||||
servers:
|
||||
- url: '{server}/api/v1'
|
||||
variables:
|
||||
@@ -48,7 +48,7 @@ servers:
|
||||
|
||||
components:
|
||||
schemas:
|
||||
Blacklist:
|
||||
Blocklist:
|
||||
type: object
|
||||
properties:
|
||||
tmdbId:
|
||||
@@ -4529,12 +4529,12 @@ paths:
|
||||
restricted:
|
||||
type: boolean
|
||||
example: false
|
||||
/blacklist:
|
||||
/blocklist:
|
||||
get:
|
||||
summary: Returns blacklisted items
|
||||
description: Returns list of all blacklisted media
|
||||
summary: Returns blocklisted items
|
||||
description: Returns list of all blocklisted media
|
||||
tags:
|
||||
- settings
|
||||
- blocklist
|
||||
parameters:
|
||||
- in: query
|
||||
name: take
|
||||
@@ -4558,11 +4558,11 @@ paths:
|
||||
name: filter
|
||||
schema:
|
||||
type: string
|
||||
enum: [all, manual, blacklistedTags]
|
||||
enum: [all, manual, blocklistedTags]
|
||||
default: manual
|
||||
responses:
|
||||
'200':
|
||||
description: Blacklisted items returned
|
||||
description: Blocklisted items returned
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -4593,25 +4593,25 @@ paths:
|
||||
type: number
|
||||
example: 438631
|
||||
post:
|
||||
summary: Add media to blacklist
|
||||
summary: Add media to blocklist
|
||||
tags:
|
||||
- blacklist
|
||||
- blocklist
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Blacklist'
|
||||
$ref: '#/components/schemas/Blocklist'
|
||||
responses:
|
||||
'201':
|
||||
description: Item succesfully blacklisted
|
||||
description: Item succesfully blocklisted
|
||||
'412':
|
||||
description: Item has already been blacklisted
|
||||
/blacklist/{tmdbId}:
|
||||
description: Item has already been blocklisted
|
||||
/blocklist/{tmdbId}:
|
||||
get:
|
||||
summary: Get media from blacklist
|
||||
summary: Get media from blocklist
|
||||
tags:
|
||||
- blacklist
|
||||
- blocklist
|
||||
parameters:
|
||||
- in: path
|
||||
name: tmdbId
|
||||
@@ -4622,11 +4622,131 @@ paths:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: Blacklist details in JSON
|
||||
description: Blocklist details in JSON
|
||||
delete:
|
||||
summary: Remove media from blacklist
|
||||
summary: Remove media from blocklist
|
||||
tags:
|
||||
- blacklist
|
||||
- blocklist
|
||||
parameters:
|
||||
- in: path
|
||||
name: tmdbId
|
||||
description: tmdbId ID
|
||||
required: true
|
||||
example: '1'
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'204':
|
||||
description: Succesfully removed media item
|
||||
/blacklist:
|
||||
get:
|
||||
summary: Returns blocklisted items
|
||||
description: |
|
||||
**DEPRECATED**: Use `/blocklist` instead. This endpoint will be deprecated soon.
|
||||
deprecated: true
|
||||
tags:
|
||||
- blocklist
|
||||
parameters:
|
||||
- in: query
|
||||
name: take
|
||||
schema:
|
||||
type: number
|
||||
nullable: true
|
||||
example: 25
|
||||
- in: query
|
||||
name: skip
|
||||
schema:
|
||||
type: number
|
||||
nullable: true
|
||||
example: 0
|
||||
- in: query
|
||||
name: search
|
||||
schema:
|
||||
type: string
|
||||
nullable: true
|
||||
example: dune
|
||||
- in: query
|
||||
name: filter
|
||||
schema:
|
||||
type: string
|
||||
enum: [all, manual, blocklistedTags]
|
||||
default: manual
|
||||
responses:
|
||||
'200':
|
||||
description: Blocklisted items returned
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
pageInfo:
|
||||
$ref: '#/components/schemas/PageInfo'
|
||||
results:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
user:
|
||||
$ref: '#/components/schemas/User'
|
||||
createdAt:
|
||||
type: string
|
||||
example: 2024-04-21T01:55:44.000Z
|
||||
id:
|
||||
type: number
|
||||
example: 1
|
||||
mediaType:
|
||||
type: string
|
||||
example: movie
|
||||
title:
|
||||
type: string
|
||||
example: Dune
|
||||
tmdbId:
|
||||
type: number
|
||||
example: 438631
|
||||
post:
|
||||
summary: Add media to blocklist
|
||||
description: |
|
||||
**DEPRECATED**: Use `/blocklist` instead. This endpoint will be deprecated soon.
|
||||
deprecated: true
|
||||
tags:
|
||||
- blocklist
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Blocklist'
|
||||
responses:
|
||||
'201':
|
||||
description: Item succesfully blocklisted
|
||||
'412':
|
||||
description: Item has already been blocklisted
|
||||
/blacklist/{tmdbId}:
|
||||
get:
|
||||
summary: Get media from blocklist
|
||||
description: |
|
||||
**DEPRECATED**: Use `/blocklist/{tmdbId}` instead. This endpoint will be deprecated soon.
|
||||
deprecated: true
|
||||
tags:
|
||||
- blocklist
|
||||
parameters:
|
||||
- in: path
|
||||
name: tmdbId
|
||||
description: tmdbId ID
|
||||
required: true
|
||||
example: '1'
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: Blocklist details in JSON
|
||||
delete:
|
||||
summary: Remove media from blocklist
|
||||
description: |
|
||||
**DEPRECATED**: Use `/blocklist/{tmdbId}` instead. This endpoint will be deprecated soon.
|
||||
deprecated: true
|
||||
tags:
|
||||
- blocklist
|
||||
parameters:
|
||||
- in: path
|
||||
name: tmdbId
|
||||
|
||||
Reference in New Issue
Block a user