mirror/formbricks
1
0
Fork 0
mirror of https://github.com/formbricks/formbricks.git synced 2026-03-13 11:09:29 -05:00
Code Issues Packages Projects Releases 138 Wiki Activity

fix: updated api docs to use - instead of > (#6107)

Browse Source
This commit is contained in:
victorvhs017
2025-06-26 23:54:34 +07:00
committed by GitHub
parent 882ad99ed7
commit 6328be220a
67 changed files with 194 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
apps/web/scripts/merge-client-endpoints.ts
View File

@@ -62,7 +62,7 @@ const v1ClientEndpoints = {
},
},
summary: "Update Response",
tags: ["Client API > Response"],
tags: ["Client API - Response"],
servers: [
{
url: "https://app.formbricks.com/api/v2",
@@ -95,7 +95,7 @@ const v1ClientEndpoints = {
},
},
summary: "Create Response",
tags: ["Client API > Response"],
tags: ["Client API - Response"],
servers: [
{
url: "https://app.formbricks.com/api/v2",
@@ -145,7 +145,7 @@ const v1ClientEndpoints = {
},
},
summary: "Update Contact (Attributes)",
tags: ["Client API > Contacts"],
tags: ["Client API - Contacts"],
servers: [
{
url: "https://app.formbricks.com/api/v2",
@@ -175,7 +175,7 @@ const v1ClientEndpoints = {
},
},
summary: "Get Contact State",
tags: ["Client API > Contacts"],
tags: ["Client API - Contacts"],
servers: [
{
url: "https://app.formbricks.com/api/v2",
@@ -208,7 +208,7 @@ const v1ClientEndpoints = {
},
},
summary: "Create Display",
tags: ["Client API > Display"],
tags: ["Client API - Display"],
servers: [
{
url: "https://app.formbricks.com/api/v2",
@@ -243,7 +243,7 @@ const v1ClientEndpoints = {
},
},
summary: "Get Environment State",
tags: ["Client API > Environment"],
tags: ["Client API - Environment"],
servers: [
{
url: "https://app.formbricks.com/api/v2",
@@ -276,7 +276,7 @@ const v1ClientEndpoints = {
},
},
summary: "Create or Identify User",
tags: ["Client API > User"],
tags: ["Client API - User"],
servers: [
{
url: "https://app.formbricks.com/api/v2",
@@ -291,7 +291,7 @@ const v1ClientEndpoints = {
summary: "Upload Private File",
description:
"API endpoint for uploading private files. Uploaded files are kept private so that only users with access to the specified environment can retrieve them. The endpoint validates the survey ID, file name, and file type from the request body, and returns a signed URL for S3 uploads along with a local upload URL.",
tags: ["Client API > File Upload"],
tags: ["Client API - File Upload"],
parameters: [
{
in: "path",
@@ -446,7 +446,7 @@ const v1ClientEndpoints = {
summary: "Upload Private File to Local Storage",
description:
'API endpoint for uploading private files to local storage. The request must include a valid signature, UUID, and timestamp to verify the upload. The file is provided as a Base64 encoded string in the request body. The "Content-Type" header must be set to a valid MIME type, and the file data must be a valid file object (buffer).',
tags: ["Client API > File Upload"],
tags: ["Client API - File Upload"],
parameters: [
{
in: "path",
@@ -472,7 +472,7 @@ const v1ClientEndpoints = {
fileName: {
type: "string",
description:
"This must be the `fileName` returned from the [Upload Private File](/api-v2-reference/client-api->-file-upload/upload-private-file) endpoint (Step 1).",
"This must be the `fileName` returned from the [Upload Private File](/api-v2-reference/client-api--file-upload/upload-private-file) endpoint (Step 1).",
},
fileType: {
type: "string",