docs(api): update api schema to have editable server url + other touchups [skip ci]

pull/820/head
sct 4 years ago
parent 9d0d5b86aa
commit 2ad85d5fdc

@ -2,8 +2,43 @@ openapi: '3.0.2'
info: info:
title: 'Overseerr API' title: 'Overseerr API'
version: '1.0.0' version: '1.0.0'
description: |
This is the documentation for the Overseerr API backend.
Two primary authentication methods are supported:
- **Cookie Authentication**: A valid login to the `/auth/login` or `/auth/local` will generate a valid authentication cookie.
- **API Key Authentication**: Login is also possible by passing an `X-Api-Key` header along with a valid API Key generated by Overseerr.
tags:
- name: public
description: Public API endpoints requiring no authentication.
- name: settings
description: Endpoints related to Overseerr's settings and configuration.
- name: auth
description: Endpoints related to logging in or out, and the currently authenticated user.
- name: users
description: Endpoints related to user management.
- name: search
description: Endpoints related to search and discovery.
- name: request
description: Endpoints related to request management.
- name: movies
description: Endpoints related to retrieving movies and their details.
- name: tv
description: Endpoints related to retrieving TV series and their details.
- name: person
description: Endpoints related to retrieving Person details.
- name: media
description: Endpoints related to media management.
- name: collection
description: Endpoints related to retrieving Collection details.
- name: service
description: Endpoinst related to getting Service (Radarr/Sonarr) details.
servers: servers:
- url: /api/v1 - url: '{server}/api/v1'
variables:
server:
default: http://localhost:5055
components: components:
schemas: schemas:
@ -119,17 +154,6 @@ components:
- machineId - machineId
- ip - ip
- port - port
PlexStatus:
type: object
properties:
settings:
$ref: '#/components/schemas/PlexSettings'
status:
type: number
example: 200
message:
type: string
example: 'OK'
PlexConnection: PlexConnection:
type: object type: object
properties: properties:
@ -394,29 +418,6 @@ components:
initialized: initialized:
type: boolean type: boolean
example: false example: false
AllSettings:
type: object
properties:
main:
$ref: '#/components/schemas/MainSettings'
plex:
$ref: '#/components/schemas/PlexSettings'
radarr:
type: array
items:
$ref: '#/components/schemas/RadarrSettings'
sonarr:
type: array
items:
$ref: '#/components/schemas/SonarrSettings'
public:
$ref: '#/components/schemas/PublicSettings'
required:
- main
- plex
- radarr
- sonarr
- public
MovieResult: MovieResult:
type: object type: object
required: required:
@ -590,7 +591,7 @@ components:
readOnly: true readOnly: true
imdbId: imdbId:
type: string type: string
example: 123 example: 'tt123'
adult: adult:
type: boolean type: boolean
backdropPath: backdropPath:
@ -2557,7 +2558,8 @@ paths:
application/json: application/json:
schema: schema:
type: array type: array
$ref: '#/components/schemas/User' items:
$ref: '#/components/schemas/User'
/user/import-from-plex: /user/import-from-plex:
post: post:
@ -3024,7 +3026,7 @@ paths:
name: requestId name: requestId
description: Request ID description: Request ID
required: true required: true
example: 1 example: '1'
schema: schema:
type: string type: string
responses: responses:
@ -3044,7 +3046,7 @@ paths:
name: requestId name: requestId
description: Request ID description: Request ID
required: true required: true
example: 1 example: '1'
schema: schema:
type: string type: string
responses: responses:
@ -3064,7 +3066,7 @@ paths:
name: requestId name: requestId
description: Request ID description: Request ID
required: true required: true
example: 1 example: '1'
schema: schema:
type: string type: string
responses: responses:
@ -3086,7 +3088,7 @@ paths:
required: true required: true
schema: schema:
type: string type: string
example: 1 example: '1'
responses: responses:
'200': '200':
description: Retry triggered description: Retry triggered
@ -3110,7 +3112,7 @@ paths:
required: true required: true
schema: schema:
type: string type: string
example: 1 example: '1'
- in: path - in: path
name: status name: status
description: New status description: New status
@ -3582,7 +3584,7 @@ paths:
name: mediaId name: mediaId
description: Media ID description: Media ID
required: true required: true
example: 1 example: '1'
schema: schema:
type: string type: string
responses: responses:
@ -3599,7 +3601,7 @@ paths:
name: mediaId name: mediaId
description: Media ID description: Media ID
required: true required: true
example: 1 example: '1'
schema: schema:
type: string type: string
- in: path - in: path

Loading…
Cancel
Save