feat!: release v2 (#6545)

Co-authored-by: Artur <145776561+arturict@users.noreply.github.com>
Co-authored-by: arturict <arturict@users.noreply.github.com>
Co-authored-by: Thomas <thomas@ajnart.fr>
Co-authored-by: Afonso Jorge Ramos <afonsojorgeramos@gmail.com>
Co-authored-by: Danura30082 <danura30082+github@gmail.com>
Co-authored-by: Kushie <122986913+kushiemoon-dev@users.noreply.github.com>
Co-authored-by: ajnart <thomas@ajnart.fr>
Co-authored-by: ajnart <thomas@ajnart.dev>
Co-authored-by: chenjun <chenjun@foxmail.com>
Co-authored-by: Wikibear <wikibear@users.noreply.github.com>
Co-authored-by: Bergasha <bergasha@gmail.com>
Co-authored-by: leafyelin <43306196+leafyelin@users.noreply.github.com>
Co-authored-by: Lucas Araujo <lucas.lra@gmail.com>
Co-authored-by: GreenMonito <86085570+GreenMonito@users.noreply.github.com>
Co-authored-by: Nerdy-Technician <roffo@nerdy-technician.social>
Co-authored-by: Jun <34545896+jcstrong@users.noreply.github.com>
Co-authored-by: Edmond Abraham <54119952+gitedmond@users.noreply.github.com>
Co-authored-by: thrawnx <tight.bulb9384@fastmail.com>
Co-authored-by: Chris <58918656+nordada@users.noreply.github.com>
Co-authored-by: yi111 <153097222+Yi-111-a@users.noreply.github.com>
Co-authored-by: Yanis <naamaneyanis@gmail.com>
Co-authored-by: Wikibear <me@sej.de>
Co-authored-by: alessiottavo <93441886+alessiottavo@users.noreply.github.com>

packages/api/src/open-api.ts

@@ -4,12 +4,15 @@ import { API_KEY_HEADER_NAME } from "@homarr/auth/api-key";
 
 import { appRouter } from "./router/app";
 import { boardRouter } from "./router/board";
+import { integrationRequestProcedure } from "./router/integration/integration-request";
 import { infoRouter } from "./router/info";
 import { inviteRouter } from "./router/invite";
 import { serverSettingsRouter } from "./router/serverSettings";
 import { userRouter } from "./router/user";
 import { createTRPCRouter } from "./trpc";
 
+export { normalizeRecursiveJsonSchemasForScalar } from "./open-api-scalar";
+
 export const openApiRouter = createTRPCRouter({
   appRouter,
   boardRouter,
@@ -17,10 +20,11 @@ export const openApiRouter = createTRPCRouter({
   inviteRouter,
   serverSettingsRouter,
   userRouter,
+  integration: createTRPCRouter({ request: integrationRequestProcedure }),
 });
 
-export const openApiDocument = (base: string) =>
-  generateOpenApiDocument(openApiRouter, {
+export const openApiDocument = (base: string) => {
+  const document = generateOpenApiDocument(openApiRouter, {
     title: "Homarr API documentation",
     version: "1.1.0",
     baseUrl: base,
@@ -34,3 +38,17 @@ export const openApiDocument = (base: string) =>
       },
     },
   });
+  // These reads support anonymous public resources and API-key-scoped private resources.
+  // The generator's boolean `protect` cannot express optional authentication.
+  for (const path of ["/api/boards", "/api/apps/{id}"]) {
+    const operation = document.paths?.[path]?.get;
+    if (operation) operation.security = [{}, { apikey: [] }];
+  }
+  // Exactly one selector is valid; generated samples otherwise fill all three.
+  const integrationBody = document.paths?.["/api/integrations/request"]?.post?.requestBody;
+  if (integrationBody && "content" in integrationBody) {
+    const json = integrationBody.content["application/json"];
+    if (json) json.example = { integrationKind: "sonarr", method: "GET", path: "/api/v3/system/status" };
+  }
+  return document;
+};