Skip to content

Update swagger docs #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Chooks22 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update swagger docs #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions api-doc/swagger_v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ components:
thumbnail:
type: string
nullable: true
status:
type: string
Comment on lines +51 to +52
Copy link

@GoldElysium GoldElysium Feb 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
status:
type: string
status:
type: string
enum: ['past', 'live', 'upcoming', 'missing', 'new']

Add possible values, makes it easier to work with the API
Don't think example would be appropiate here.

live_schedule:
type: string
nullable: true
Expand All @@ -68,6 +70,8 @@ components:
- $ref: "#/components/schemas/LiveVideo"
- type: object
properties:
published_at:
type: string
Comment on lines +73 to +74
Copy link

@GoldElysium GoldElysium Feb 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
published_at:
type: string
published_at:
type: string
format: date-time

Add a format as specified here: Data types
Could be useful, though not really important. If it gets changed here, everywhere else should be changed too.

is_uploaded:
type: boolean
nullable: true
Expand Down Expand Up @@ -117,6 +121,12 @@ components:
type: string
example: yuzukichococh
nullable: true
view_count:
type: integer
subscribers:
type: integer
videos:
type: integer

Comment:
type: object
Expand Down Expand Up @@ -615,15 +625,18 @@ paths:
schema:
type: object
properties:
data:
comments:
type: array
description: >
List of videos, along with channel and matched comments.
items:
$ref: "#/components/schemas/VideoWithComment"
total:
type: integer
description: Count of total number of matched comments.
count:
type: integer
description: Count of total number of videos.
description: Number of comments fetched.
cached:
type: boolean
description: Whether the response was from cache or not.
Expand Down