Update API Doc

This commit is contained in:
Rudi committed 2026-10-13 19:26:56 +02:00
1 parent 5d6d8f15f3
commit 5a56245218
10 files changed
+1196 -229

No files matched your search

+47 -21
View File
@@ -1,22 +1,45 @@
// @wikiCategory: Liederbücher
// @/app/api/songbooks/route.ts
import { NextResponse } from "next/server";
import { getSongBooks, searchSongBooksByTitle, createSongBook } from "@/lib/db/songbook";
/**
* @openapi
* /api/songbooks:
* get:
* summary: Get all songbooks
* summary: Get all songbooks or search songbooks by title
* tags:
* - Songbooks
* parameters:
* - in: query
* name: query
* required: false
* schema:
* type: string
* description: Search term for the songbook title
* example: "Feiert Jesus"
* - in: query
* name: q
* required: false
* schema:
* type: string
* description: Alias for `query`
* example: "Feiert Jesus"
* responses:
* 200:
* description: List of songbooks
* description: List of songbooks (filtered by title if a query is given)
* content:
* application/json:
* schema:
* type: array
* items:
* $ref: '#/components/schemas/SongBook'
* 500:
* description: Internal Server Error
*
* @wikiDescription: Liste aller Liederbücher abrufen
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function GET(request: Request) {
try {
@@ -60,6 +83,8 @@ export async function GET(request: Request) {
* /api/songbooks:
* post:
* summary: Creates a new songbook
* tags:
* - Songbooks
* requestBody:
* required: true
* content:
@@ -68,6 +93,7 @@ export async function GET(request: Request) {
* type: object
* required:
* - title
* - language
* properties:
* title:
* type: string
@@ -87,25 +113,25 @@ export async function GET(request: Request) {
* type: boolean
* example: true
* songBook:
* type: object
* properties:
* id:
* type: integer
* example: 1
* title:
* type: string
* example: "Feiert Jesus 1"
* language:
* type: string
* example: "DE"
* $ref: '#/components/schemas/SongBook'
* 400:
* description: Bad Request (missing title)
* description: Bad Request (missing title or language)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 409:
* description: Conflict (title already exists)
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
* 500:
* description: Internal Server Error
*
* @wikiDescription: Neues Liederbuch erstellen
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Error'
*/
export async function POST(request: Request) {
try {