From b5a9bd902f7619985d76f6b7e304b96a0aca59bb Mon Sep 17 00:00:00 2001
From: Agate <me@agate.blue>
Date: Mon, 22 Jun 2020 16:59:06 +0200
Subject: [PATCH] Added mising ordering options in swagger docs
---
docs/swagger.yml | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/docs/swagger.yml b/docs/swagger.yml
index c00ab184b..7460b9e64 100644
--- a/docs/swagger.yml
+++ b/docs/swagger.yml
@@ -360,9 +360,12 @@ paths:
- creation_date
- id
- name
+ - random
- $ref: "#/parameters/Playable"
+ - $ref: "#/parameters/Library"
- $ref: "#/parameters/PageNumber"
- $ref: "#/parameters/PageSize"
+ - $ref: "#/parameters/Related"
- $ref: "#/parameters/Scope"
responses:
@@ -456,9 +459,12 @@ paths:
- creation_date
- release_date
- title
+ - random
+ - $ref: "#/parameters/Library"
- $ref: "#/parameters/Playable"
- $ref: "#/parameters/PageNumber"
- $ref: "#/parameters/PageSize"
+ - $ref: "#/parameters/Related"
- $ref: "#/parameters/Scope"
responses:
@@ -577,9 +583,12 @@ paths:
- creation_date
- release_date
- title
+ - random
+ - $ref: "#/parameters/Library"
- $ref: "#/parameters/Playable"
- $ref: "#/parameters/PageNumber"
- $ref: "#/parameters/PageSize"
+ - $ref: "#/parameters/Related"
- $ref: "#/parameters/Scope"
responses:
@@ -848,6 +857,17 @@ paths:
tags:
- "Channels and subscriptions"
parameters:
+ - allOf:
+ - $ref: "#/parameters/Ordering"
+ - default: "-creation_date"
+ schema:
+ required: false
+ type: "string"
+ example: "creation_date"
+ enum:
+ - creation_date
+ - modification_date
+ - random
- $ref: "#/parameters/PageNumber"
- $ref: "#/parameters/PageSize"
- $ref: "#/parameters/Scope"
@@ -1396,6 +1416,15 @@ parameters:
schema:
type: integer
format: int64
+
+ Library:
+ name: library
+ in: query
+ description: Restrict to results contained in the given library
+ schema:
+ type: string
+ format: uuid
+
Ordering:
name: "ordering"
in: "query"
@@ -1437,6 +1466,14 @@ parameters:
required: false
type: "boolean"
+ Related:
+ name: related
+ in: query
+ description: Restrict to results similar to the given object (based on tags)
+ schema:
+ type: integer
+ format: int64
+
Scope:
name: "scope"
in: "query"
--
GitLab