Mirrors/audiobookshelf
Mirrors/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2024-12-20 19:06:06 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update JSDocs for feeds endpoints

Browse Source
This commit is contained in:
advplyr 2024-12-08 08:05:33 -06:00
parent b38ce41731
commit 5646466aa3
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
server/managers/RssFeedManager.js
View File

@ -1,3 +1,4 @@
const { Request, Response } = require('express')
const Path = require('path') const Path = require('path')
const Logger = require('../Logger') const Logger = require('../Logger')
@ -77,6 +78,12 @@ class RssFeedManager {
return Database.feedModel.findByPkOld(id) return Database.feedModel.findByPkOld(id)
} }
/**
* GET: /feed/:slug
*
* @param {Request} req
* @param {Response} res
*/
async getFeed(req, res) { async getFeed(req, res) {
const feed = await this.findFeedBySlug(req.params.slug) const feed = await this.findFeedBySlug(req.params.slug)
if (!feed) { if (!feed) {
@ -167,6 +174,12 @@ class RssFeedManager {
res.send(xml) res.send(xml)
} }
/**
* GET: /feed/:slug/item/:episodeId/*
*
* @param {Request} req
* @param {Response} res
*/
async getFeedItem(req, res) { async getFeedItem(req, res) {
const feed = await this.findFeedBySlug(req.params.slug) const feed = await this.findFeedBySlug(req.params.slug)
if (!feed) { if (!feed) {
@ -183,6 +196,12 @@ class RssFeedManager {
res.sendFile(episodePath) res.sendFile(episodePath)
} }
/**
* GET: /feed/:slug/cover*
*
* @param {Request} req
* @param {Response} res
*/
async getFeedCover(req, res) { async getFeedCover(req, res) {
const feed = await this.findFeedBySlug(req.params.slug) const feed = await this.findFeedBySlug(req.params.slug)
if (!feed) { if (!feed) {