openapi! yay

src/web/endpoints/back/getTrackMetadata.ts

@@ -2,19 +2,32 @@ import { appleMusicApi } from "../../../appleMusicApi/index.js";
 import express from "express";
 import { validate } from "../../validate.js";
 import { z } from "zod";
+import { paths } from "../../openApi.js";
 
 const router = express.Router();
 
+const path = "/getTrackMetadata";
 const schema = z.object({
     query: z.object({
         id: z.string()
     })
 });
 
+paths[path] = {
+    get: {
+        requestParams: { query: schema.shape.query },
+        responses: {
+            200: { description: "returns from the apple music api, track metadata with `extendedAssetUrls` extension and `albums` relationship https://developer.apple.com/documentation/applemusicapi/get-a-catalog-song" },
+            400: { description: "bad request, invalid query parameters. sent as a zod error with details" },
+            default: { description: "upstream api error, or some other error" }
+        }
+    }
+};
+
 // this endpoint isn't actually used for anything by us
 // it's for people who want to implement apple music downloading into their own apps (ex. discord music bot)
 // it makes it a bit easier to get the metadata for a track knowing the trackId
-router.get("/getTrackMetadata", async (req, res, next) => {
+router.get(path, async (req, res, next) => {
     try {
         const { id } = (await validate(req, schema)).query;