mirror/formbricks
1
0
Fork 0
mirror of https://github.com/formbricks/formbricks.git synced 2026-05-22 02:56:28 -05:00
Code Issues Packages Projects Releases 178 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
docs/api-v2-reference/openapi.yml
+59 -51
View File
@@ -11,25 +11,25 @@ tags:
description: Operations for managing roles.
- name: Me
description: Operations for managing your API key.
- name: Management API > Responses
- name: Management API - Responses
description: Operations for managing responses.
- name: Management API > Contacts
- name: Management API - Contacts
description: Operations for managing contacts.
- name: Management API > Contact Attributes
- name: Management API - Contact Attributes
description: Operations for managing contact attributes.
- name: Management API > Contact Attributes Keys
description: Operations for managing contact attributes keys.
- name: Management API > Surveys
- name: Management API - Contact Attribute Keys
description: Operations for managing contact attribute keys.
- name: Management API - Surveys
description: Operations for managing surveys.
- name: Management API > Surveys > Contact Links
- name: Management API - Surveys - Contact Links
description: Operations for generating personalized survey links for contacts.
- name: Management API > Webhooks
- name: Management API - Webhooks
description: Operations for managing webhooks.
- name: Organizations API > Teams
- name: Organizations API - Teams
description: Operations for managing teams.
- name: Organizations API > Project Teams
- name: Organizations API - Project Teams
description: Operations for managing project teams.
- name: Organizations API > Users
- name: Organizations API - Users
description: Operations for managing users.
security:
- apiKeyAuth: []
@@ -82,7 +82,7 @@ paths:
description: Not Found
summary: Update Response
tags:
- Client API > Response
- Client API - Response
servers:
- url: https://app.formbricks.com/api/v2
description: Formbricks Client
@@ -110,7 +110,7 @@ paths:
description: Created
summary: Create Response
tags:
- Client API > Response
- Client API - Response
servers:
- url: https://app.formbricks.com/api/v2
description: Formbricks Client
@@ -159,7 +159,7 @@ paths:
description: Internal Server Error
summary: Update Contact (Attributes)
tags:
- Client API > Contacts
- Client API - Contacts
servers:
- url: https://app.formbricks.com/api/v2
description: Formbricks Client
@@ -192,7 +192,7 @@ paths:
description: OK
summary: Get Contact State
tags:
- Client API > Contacts
- Client API - Contacts
servers:
- url: https://app.formbricks.com/api/v2
description: Formbricks Client
@@ -220,7 +220,7 @@ paths:
description: Created
summary: Create Display
tags:
- Client API > Display
- Client API - Display
servers:
- url: https://app.formbricks.com/api/v2
description: Formbricks Client
@@ -252,7 +252,7 @@ paths:
description: OK
summary: Get Environment State
tags:
- Client API > Environment
- Client API - Environment
servers:
- url: https://app.formbricks.com/api/v2
description: Formbricks Client
@@ -283,7 +283,7 @@ paths:
description: OK
summary: Create or Identify User
tags:
- Client API > User
- Client API - User
servers:
- url: https://app.formbricks.com/api/v2
description: Formbricks Client
@@ -297,7 +297,7 @@ paths:
type from the request body, and returns a signed URL for S3 uploads
along with a local upload URL.
tags:
- Client API > File Upload
- Client API - File Upload
parameters:
- in: path
name: environmentId
@@ -408,7 +408,7 @@ paths:
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
- Client API - File Upload
parameters:
- in: path
name: environmentId
@@ -429,7 +429,7 @@ paths:
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)
File](/api-v2-reference/client-api--file-upload/upload-private-file)
endpoint (Step 1).
fileType:
type: string
@@ -627,7 +627,7 @@ paths:
summary: Get responses
description: Gets responses from the database.
tags:
- Management API > Responses
- Management API - Responses
parameters:
- in: query
name: limit
@@ -840,7 +840,7 @@ paths:
summary: Create a response
description: Creates a response in the database.
tags:
- Management API > Responses
- Management API - Responses
requestBody:
required: true
description: The response to create
@@ -1064,7 +1064,7 @@ paths:
summary: Get a response
description: Gets a response from the database.
tags:
- Management API > Responses
- Management API - Responses
parameters:
- in: path
name: id
@@ -1191,7 +1191,7 @@ paths:
summary: Update a response
description: Updates a response in the database.
tags:
- Management API > Responses
- Management API - Responses
parameters:
- in: path
name: id
@@ -1401,7 +1401,7 @@ paths:
summary: Delete a response
description: Deletes a response from the database.
tags:
- Management API > Responses
- Management API - Responses
parameters:
- in: path
name: id
@@ -1533,7 +1533,7 @@ paths:
is mandatory and must be a valid email format. Without a valid email,
the contact will be skipped during processing.
tags:
- Management API > Contacts
- Management API - Contacts
requestBody:
required: true
description: The contacts to upload. Each contact must include an 'email'
@@ -1665,7 +1665,7 @@ paths:
summary: Get contact attribute keys
description: Gets contact attribute keys from the database.
tags:
- Management API > Contact Attribute Keys
- Management API - Contact Attribute Keys
parameters:
- in: query
name: limit
@@ -1786,7 +1786,7 @@ paths:
summary: Create a contact attribute key
description: Creates a contact attribute key in the database.
tags:
- Management API > Contact Attribute Keys
- Management API - Contact Attribute Keys
requestBody:
required: true
description: The contact attribute key to create
@@ -1850,7 +1850,7 @@ paths:
summary: Get a contact attribute key
description: Gets a contact attribute key from the database.
tags:
- Management API > Contact Attribute Keys
- Management API - Contact Attribute Keys
parameters:
- in: path
name: id
@@ -1912,7 +1912,7 @@ paths:
summary: Update a contact attribute key
description: Updates a contact attribute key in the database.
tags:
- Management API > Contact Attribute Keys
- Management API - Contact Attribute Keys
parameters:
- in: path
name: id
@@ -1981,7 +1981,7 @@ paths:
summary: Delete a contact attribute key
description: Deletes a contact attribute key from the database.
tags:
- Management API > Contact Attribute Keys
- Management API - Contact Attribute Keys
parameters:
- in: path
name: id
@@ -2045,7 +2045,7 @@ paths:
summary: Get personalized survey link for a contact
description: Retrieves a personalized link for a specific survey.
tags:
- Management API > Surveys > Contact Links
- Management API - Surveys - Contact Links
parameters:
- in: path
name: surveyId
@@ -2084,7 +2084,7 @@ paths:
summary: Get survey links for contacts in a segment
description: Generates personalized survey links for contacts in a segment.
tags:
- Management API > Surveys > Contact Links
- Management API - Surveys - Contact Links
parameters:
- in: path
name: surveyId
@@ -2183,7 +2183,7 @@ paths:
summary: Get webhooks
description: Gets webhooks from the database.
tags:
- Management API > Webhooks
- Management API - Webhooks
parameters:
- in: query
name: limit
@@ -2288,6 +2288,7 @@ paths:
- responseFinished
- responseCreated
- responseUpdated
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array
@@ -2308,7 +2309,7 @@ paths:
summary: Create a webhook
description: Creates a webhook in the database.
tags:
- Management API > Webhooks
- Management API - Webhooks
requestBody:
required: true
description: The webhook to create
@@ -2338,6 +2339,7 @@ paths:
items:
type: string
enum: *a10
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array
@@ -2391,6 +2393,7 @@ paths:
items:
type: string
enum: *a10
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array
@@ -2404,7 +2407,7 @@ paths:
summary: Get a webhook
description: Gets a webhook from the database.
tags:
- Management API > Webhooks
- Management API - Webhooks
parameters:
- in: path
name: id
@@ -2452,6 +2455,7 @@ paths:
items:
type: string
enum: *a10
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array
@@ -2463,7 +2467,7 @@ paths:
summary: Update a webhook
description: Updates a webhook in the database.
tags:
- Management API > Webhooks
- Management API - Webhooks
parameters:
- in: path
name: id
@@ -2500,6 +2504,7 @@ paths:
items:
type: string
enum: *a10
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array
@@ -2553,6 +2558,7 @@ paths:
items:
type: string
enum: *a10
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array
@@ -2564,7 +2570,7 @@ paths:
summary: Delete a webhook
description: Deletes a webhook from the database.
tags:
- Management API > Webhooks
- Management API - Webhooks
parameters:
- in: path
name: id
@@ -2612,6 +2618,7 @@ paths:
items:
type: string
enum: *a10
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array
@@ -2627,7 +2634,7 @@ paths:
summary: Get teams
description: Gets teams from the database.
tags:
- Organizations API > Teams
- Organizations API - Teams
parameters:
- in: path
name: organizationId
@@ -2725,7 +2732,7 @@ paths:
summary: Create a team
description: Creates a team in the database.
tags:
- Organizations API > Teams
- Organizations API - Teams
parameters:
- in: path
name: organizationId
@@ -2780,7 +2787,7 @@ paths:
summary: Get a team
description: Gets a team from the database.
tags:
- Organizations API > Teams
- Organizations API - Teams
parameters:
- in: path
name: id
@@ -2825,7 +2832,7 @@ paths:
summary: Update a team
description: Updates a team in the database.
tags:
- Organizations API > Teams
- Organizations API - Teams
parameters:
- in: path
name: id
@@ -2884,7 +2891,7 @@ paths:
summary: Delete a team
description: Deletes a team from the database.
tags:
- Organizations API > Teams
- Organizations API - Teams
parameters:
- in: path
name: id
@@ -2931,7 +2938,7 @@ paths:
summary: Get project teams
description: Gets projectTeams from the database.
tags:
- Organizations API > Project Teams
- Organizations API - Project Teams
parameters:
- in: path
name: organizationId
@@ -3040,7 +3047,7 @@ paths:
summary: Create a projectTeam
description: Creates a project team in the database.
tags:
- Organizations API > Project Teams
- Organizations API - Project Teams
parameters:
- in: path
name: organizationId
@@ -3107,7 +3114,7 @@ paths:
summary: Update a project team
description: Updates a project team in the database.
tags:
- Organizations API > Project Teams
- Organizations API - Project Teams
parameters:
- in: path
name: organizationId
@@ -3174,7 +3181,7 @@ paths:
summary: Delete a project team
description: Deletes a project team from the database.
tags:
- Organizations API > Project Teams
- Organizations API - Project Teams
parameters:
- in: path
name: organizationId
@@ -3229,7 +3236,7 @@ paths:
description: Gets users from the database.<br />Only available for self-hosted
Formbricks.
tags:
- Organizations API > Users
- Organizations API - Users
parameters:
- in: path
name: organizationId
@@ -3365,7 +3372,7 @@ paths:
description: Create a new user in the database.<br />Only available for
self-hosted Formbricks.
tags:
- Organizations API > Users
- Organizations API - Users
parameters:
- in: path
name: organizationId
@@ -3468,7 +3475,7 @@ paths:
description: Updates an existing user in the database.<br />Only available for
self-hosted Formbricks.
tags:
- Organizations API > Users
- Organizations API - Users
parameters:
- in: path
name: organizationId
@@ -4516,6 +4523,7 @@ components:
items:
type: string
enum: *a10
minItems: 1
description: The triggers of the webhook
surveyIds:
type: array