fix: openAPI spec for contact endpoints (#5247)

Co-authored-by: Victor Santos <victor@formbricks.com>
2026-05-03 19:40:08 -05:00 · 2025-04-10 15:52:40 +05:30
parent c7d6ed9ea3
commit 1132bdd66a
22 changed files with 181 additions and 1259 deletions
@@ -265,7 +265,7 @@ export const MainNavigation = ({
                size="icon"
                onClick={toggleSidebar}
                className={cn(
-                  "rounded-xl bg-slate-50 p-1 text-slate-600 transition-all hover:bg-slate-100 focus:outline-none focus:ring-0 focus:ring-transparent"
+                  "rounded-xl bg-slate-50 p-1 text-slate-600 transition-all hover:bg-slate-100 focus:ring-0 focus:ring-transparent focus:outline-none"
                )}>
                {isCollapsed ? (
                  <PanelLeftOpenIcon strokeWidth={1.5} />
@@ -1,6 +1,9 @@
 import { z } from "zod";
+import { extendZodWithOpenApi } from "zod-openapi";
 import { ZContactAttributeKey } from "@formbricks/database/zod/contact-attribute-keys";

+extendZodWithOpenApi(z);
+
 export const ZGetContactAttributeKeysFilter = z
  .object({
    limit: z.coerce.number().positive().min(1).max(100).optional().default(10),
@@ -1,6 +1,9 @@
 import { z } from "zod";
+import { extendZodWithOpenApi } from "zod-openapi";
 import { ZContact } from "@formbricks/database/zod/contact";

+extendZodWithOpenApi(z);
+
 export const ZGetContactsFilter = z
  .object({
    limit: z.coerce.number().positive().min(1).max(100).optional().default(10),
@@ -0,0 +1,30 @@
+import { ZContactLinkParams } from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/types/survey";
+import { makePartialSchema } from "@/modules/api/v2/types/openapi-response";
+import { z } from "zod";
+import { ZodOpenApiOperationObject } from "zod-openapi";
+
+export const getPersonalizedSurveyLink: ZodOpenApiOperationObject = {
+  operationId: "getPersonalizedSurveyLink",
+  summary: "Get personalized survey link for a contact",
+  description: "Retrieves a personalized link for a specific survey.",
+  requestParams: {
+    path: ZContactLinkParams,
+  },
+  tags: ["Management API > Surveys > Contact Links"],
+  responses: {
+    "200": {
+      description: "Personalized survey link retrieved successfully.",
+      content: {
+        "application/json": {
+          schema: makePartialSchema(
+            z.object({
+              data: z.object({
+                surveyUrl: z.string().url(),
+              }),
+            })
+          ),
+        },
+      },
+    },
+  },
+};
@@ -5,20 +5,14 @@ import { getEnvironmentId } from "@/modules/api/v2/management/lib/helper";
 import { getContact } from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/contacts";
 import { getResponse } from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/response";
 import { getSurvey } from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/surveys";
+import {
+  TContactLinkParams,
+  ZContactLinkParams,
+} from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/types/survey";
 import { getContactSurveyLink } from "@/modules/ee/contacts/lib/contact-survey-link";
 import { hasPermission } from "@/modules/organization/settings/api-keys/lib/utils";
-import { z } from "zod";
-import { ZId } from "@formbricks/types/common";

-const ZContactLinkParams = z.object({
-  surveyId: ZId,
-  contactId: ZId,
-});
-
-export const GET = async (
-  request: Request,
-  props: { params: Promise<{ surveyId: string; contactId: string }> }
-) =>
+export const GET = async (request: Request, props: { params: Promise<TContactLinkParams> }) =>
  authenticatedApiClient({
    request,
    externalParams: props.params,
@@ -0,0 +1,23 @@
+import { z } from "zod";
+import { extendZodWithOpenApi } from "zod-openapi";
+
+extendZodWithOpenApi(z);
+
+export const ZContactLinkParams = z.object({
+  surveyId: z
+    .string()
+    .cuid2()
+    .openapi({
+      description: "The ID of the survey",
+      param: { name: "surveyId", in: "path" },
+    }),
+  contactId: z
+    .string()
+    .cuid2()
+    .openapi({
+      description: "The ID of the contact",
+      param: { name: "contactId", in: "path" },
+    }),
+});
+
+export type TContactLinkParams = z.infer<typeof ZContactLinkParams>;
@@ -4,7 +4,6 @@ import {
  ZContactLinksBySegmentQuery,
 } from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/segments/[segmentId]/types/contact";
 import { makePartialSchema, responseWithMetaSchema } from "@/modules/api/v2/types/openapi-response";
-import { z } from "zod";
 import { ZodOpenApiOperationObject } from "zod-openapi";

 export const getContactLinksBySegmentEndpoint: ZodOpenApiOperationObject = {
@@ -21,7 +20,7 @@ export const getContactLinksBySegmentEndpoint: ZodOpenApiOperationObject = {
      description: "Contact links generated successfully.",
      content: {
        "application/json": {
-          schema: z.array(responseWithMetaSchema(makePartialSchema(ZContactLinkResponse))),
+          schema: responseWithMetaSchema(makePartialSchema(ZContactLinkResponse)),
        },
      },
    },
@@ -1,9 +1,24 @@
 import { ZGetFilter } from "@/modules/api/v2/types/api-filter";
 import { z } from "zod";
+import { extendZodWithOpenApi } from "zod-openapi";
+
+extendZodWithOpenApi(z);

 export const ZContactLinksBySegmentParams = z.object({
-  surveyId: z.string().cuid2().describe("The ID of the survey"),
-  segmentId: z.string().cuid2().describe("The ID of the segment"),
+  surveyId: z
+    .string()
+    .cuid2()
+    .openapi({
+      description: "The ID of the survey",
+      param: { name: "surveyId", in: "path" },
+    }),
+  segmentId: z
+    .string()
+    .cuid2()
+    .openapi({
+      description: "The ID of the segment",
+      param: { name: "segmentId", in: "path" },
+    }),
 });

 export const ZContactLinksBySegmentQuery = ZGetFilter.pick({
@@ -1,9 +1,10 @@
+// import {
+//   deleteSurveyEndpoint,
+//   getSurveyEndpoint,
+//   updateSurveyEndpoint,
+// } from "@/modules/api/v2/management/surveys/[surveyId]/lib/openapi";
 import { managementServer } from "@/modules/api/v2/management/lib/openapi";
-import {
-  deleteSurveyEndpoint,
-  getSurveyEndpoint,
-  updateSurveyEndpoint,
-} from "@/modules/api/v2/management/surveys/[surveyId]/lib/openapi";
+import { getPersonalizedSurveyLink } from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/openapi";
 import { ZGetSurveysFilter, ZSurveyInput } from "@/modules/api/v2/management/surveys/types/surveys";
 import { z } from "zod";
 import { ZodOpenApiOperationObject, ZodOpenApiPathsObject } from "zod-openapi";
@@ -56,15 +57,19 @@ export const createSurveyEndpoint: ZodOpenApiOperationObject = {
 };

 export const surveyPaths: ZodOpenApiPathsObject = {
-  "/surveys": {
+  // "/surveys": {
+  //   servers: managementServer,
+  //   get: getSurveysEndpoint,
+  //   post: createSurveyEndpoint,
+  // },
+  // "/surveys/{id}": {
+  //   servers: managementServer,
+  //   get: getSurveyEndpoint,
+  //   put: updateSurveyEndpoint,
+  //   delete: deleteSurveyEndpoint,
+  // },
+  "/surveys/{surveyId}/contact-links/contacts/{contactId}/": {
    servers: managementServer,
-    get: getSurveysEndpoint,
-    post: createSurveyEndpoint,
-  },
-  "/surveys/{id}": {
-    servers: managementServer,
-    get: getSurveyEndpoint,
-    put: updateSurveyEndpoint,
-    delete: deleteSurveyEndpoint,
+    get: getPersonalizedSurveyLink,
  },
 };
@@ -1,6 +1,9 @@
 import { z } from "zod";
+import { extendZodWithOpenApi } from "zod-openapi";
 import { ZSurveyWithoutQuestionType } from "@formbricks/database/zod/surveys";

+extendZodWithOpenApi(z);
+
 export const ZGetSurveysFilter = z
  .object({
    limit: z.coerce.number().positive().min(1).max(100).optional().default(10),
@@ -1,6 +1,6 @@
-import { contactAttributeKeyPaths } from "@/modules/api/v2/management/contact-attribute-keys/lib/openapi";
-import { contactAttributePaths } from "@/modules/api/v2/management/contact-attributes/lib/openapi";
-import { contactPaths } from "@/modules/api/v2/management/contacts/lib/openapi";
+// import { contactAttributeKeyPaths } from "@/modules/api/v2/management/contact-attribute-keys/lib/openapi";
+// import { contactAttributePaths } from "@/modules/api/v2/management/contact-attributes/lib/openapi";
+// import { contactPaths } from "@/modules/api/v2/management/contacts/lib/openapi";
 import { responsePaths } from "@/modules/api/v2/management/responses/lib/openapi";
 import { surveyContactLinksBySegmentPaths } from "@/modules/api/v2/management/surveys/[surveyId]/contact-links/segments/lib/openapi";
 import { surveyPaths } from "@/modules/api/v2/management/surveys/lib/openapi";
@@ -40,9 +40,9 @@ const document = createDocument({
    ...mePaths,
    ...responsePaths,
    ...bulkContactPaths,
-    ...contactPaths,
-    ...contactAttributePaths,
-    ...contactAttributeKeyPaths,
+    // ...contactPaths,
+    // ...contactAttributePaths,
+    // ...contactAttributeKeyPaths,
    ...surveyPaths,
    ...surveyContactLinksBySegmentPaths,
    ...webhookPaths,
@@ -52,7 +52,7 @@ const document = createDocument({
  },
  servers: [
    {
-      url: `https://app.formbricks.com/api/v2/`,
+      url: "https://app.formbricks.com/api/v2",
      description: "Formbricks Cloud",
    },
  ],
@@ -751,7 +751,7 @@ export const FollowUpModal = ({
            </div>
          </div>

-          <div className="absolute bottom-0 right-0 z-20 h-12 w-full bg-white p-2">
+          <div className="absolute right-0 bottom-0 z-20 h-12 w-full bg-white p-2">
            <div className="flex justify-end space-x-2">
              <Button
                type="button"