mirror/formbricks
1
0
Fork 0
mirror of https://github.com/formbricks/formbricks.git synced 2026-01-06 00:49:42 -06:00
Code Issues Packages Projects Releases 118 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

6
apps/web/modules/api/v2/management/contact-attribute-keys/[contactAttributeKeyId]/lib/openapi.ts
View File

@@ -16,7 +16,7 @@ export const getContactAttributeKeyEndpoint: ZodOpenApiOperationObject = {
id: ZContactAttributeKeyIdSchema,
}),
},
tags: ["Management API > Contact Attribute Keys"],
tags: ["Management API - Contact Attribute Keys"],
responses: {
"200": {
description: "Contact attribute key retrieved successfully.",
@@ -33,7 +33,7 @@ export const updateContactAttributeKeyEndpoint: ZodOpenApiOperationObject = {
operationId: "updateContactAttributeKey",
summary: "Update a contact attribute key",
description: "Updates a contact attribute key in the database.",
tags: ["Management API > Contact Attribute Keys"],
tags: ["Management API - Contact Attribute Keys"],
requestParams: {
path: z.object({
id: ZContactAttributeKeyIdSchema,
@@ -64,7 +64,7 @@ export const deleteContactAttributeKeyEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteContactAttributeKey",
summary: "Delete a contact attribute key",
description: "Deletes a contact attribute key from the database.",
tags: ["Management API > Contact Attribute Keys"],
tags: ["Management API - Contact Attribute Keys"],
requestParams: {
path: z.object({
id: ZContactAttributeKeyIdSchema,

4
apps/web/modules/api/v2/management/contact-attribute-keys/lib/openapi.ts
View File

@@ -16,7 +16,7 @@ export const getContactAttributeKeysEndpoint: ZodOpenApiOperationObject = {
operationId: "getContactAttributeKeys",
summary: "Get contact attribute keys",
description: "Gets contact attribute keys from the database.",
tags: ["Management API > Contact Attribute Keys"],
tags: ["Management API - Contact Attribute Keys"],
requestParams: {
query: ZGetContactAttributeKeysFilter.sourceType(),
},
@@ -36,7 +36,7 @@ export const createContactAttributeKeyEndpoint: ZodOpenApiOperationObject = {
operationId: "createContactAttributeKey",
summary: "Create a contact attribute key",
description: "Creates a contact attribute key in the database.",
tags: ["Management API > Contact Attribute Keys"],
tags: ["Management API - Contact Attribute Keys"],
requestBody: {
required: true,
description: "The contact attribute key to create",

6
apps/web/modules/api/v2/management/contact-attributes/[contactAttributeId]/lib/openapi.ts
View File

@@ -12,7 +12,7 @@ export const getContactAttributeEndpoint: ZodOpenApiOperationObject = {
contactAttributeId: z.string().cuid2(),
}),
},
tags: ["Management API > Contact Attributes"],
tags: ["Management API - Contact Attributes"],
responses: {
"200": {
description: "Contact retrieved successfully.",
@@ -29,7 +29,7 @@ export const deleteContactAttributeEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteContactAttribute",
summary: "Delete a contact attribute",
description: "Deletes a contact attribute from the database.",
tags: ["Management API > Contact Attributes"],
tags: ["Management API - Contact Attributes"],
requestParams: {
path: z.object({
contactAttributeId: z.string().cuid2(),
@@ -51,7 +51,7 @@ export const updateContactAttributeEndpoint: ZodOpenApiOperationObject = {
operationId: "updateContactAttribute",
summary: "Update a contact attribute",
description: "Updates a contact attribute in the database.",
tags: ["Management API > Contact Attributes"],
tags: ["Management API - Contact Attributes"],
requestParams: {
path: z.object({
contactAttributeId: z.string().cuid2(),

4
apps/web/modules/api/v2/management/contact-attributes/lib/openapi.ts
View File

@@ -16,7 +16,7 @@ export const getContactAttributesEndpoint: ZodOpenApiOperationObject = {
operationId: "getContactAttributes",
summary: "Get contact attributes",
description: "Gets contact attributes from the database.",
tags: ["Management API > Contact Attributes"],
tags: ["Management API - Contact Attributes"],
requestParams: {
query: ZGetContactAttributesFilter,
},
@@ -36,7 +36,7 @@ export const createContactAttributeEndpoint: ZodOpenApiOperationObject = {
operationId: "createContactAttribute",
summary: "Create a contact attribute",
description: "Creates a contact attribute in the database.",
tags: ["Management API > Contact Attributes"],
tags: ["Management API - Contact Attributes"],
requestBody: {
required: true,
description: "The contact attribute to create",

6
apps/web/modules/api/v2/management/contacts/[contactId]/lib/openapi.ts
View File

@@ -12,7 +12,7 @@ export const getContactEndpoint: ZodOpenApiOperationObject = {
contactId: z.string().cuid2(),
}),
},
tags: ["Management API > Contacts"],
tags: ["Management API - Contacts"],
responses: {
"200": {
description: "Contact retrieved successfully.",
@@ -29,7 +29,7 @@ export const deleteContactEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteContact",
summary: "Delete a contact",
description: "Deletes a contact from the database.",
tags: ["Management API > Contacts"],
tags: ["Management API - Contacts"],
requestParams: {
path: z.object({
contactId: z.string().cuid2(),
@@ -51,7 +51,7 @@ export const updateContactEndpoint: ZodOpenApiOperationObject = {
operationId: "updateContact",
summary: "Update a contact",
description: "Updates a contact in the database.",
tags: ["Management API > Contacts"],
tags: ["Management API - Contacts"],
requestParams: {
path: z.object({
contactId: z.string().cuid2(),

4
apps/web/modules/api/v2/management/contacts/lib/openapi.ts
View File

@@ -16,7 +16,7 @@ export const getContactsEndpoint: ZodOpenApiOperationObject = {
requestParams: {
query: ZGetContactsFilter,
},
tags: ["Management API > Contacts"],
tags: ["Management API - Contacts"],
responses: {
"200": {
description: "Contacts retrieved successfully.",
@@ -33,7 +33,7 @@ export const createContactEndpoint: ZodOpenApiOperationObject = {
operationId: "createContact",
summary: "Create a contact",
description: "Creates a contact in the database.",
tags: ["Management API > Contacts"],
tags: ["Management API - Contacts"],
requestBody: {
required: true,
description: "The contact to create",

6
apps/web/modules/api/v2/management/responses/[responseId]/lib/openapi.ts
View File

@@ -14,7 +14,7 @@ export const getResponseEndpoint: ZodOpenApiOperationObject = {
id: ZResponseIdSchema,
}),
},
tags: ["Management API > Responses"],
tags: ["Management API - Responses"],
responses: {
"200": {
description: "Response retrieved successfully.",
@@ -31,7 +31,7 @@ export const deleteResponseEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteResponse",
summary: "Delete a response",
description: "Deletes a response from the database.",
tags: ["Management API > Responses"],
tags: ["Management API - Responses"],
requestParams: {
path: z.object({
id: ZResponseIdSchema,
@@ -53,7 +53,7 @@ export const updateResponseEndpoint: ZodOpenApiOperationObject = {
operationId: "updateResponse",
summary: "Update a response",
description: "Updates a response in the database.",
tags: ["Management API > Responses"],
tags: ["Management API - Responses"],
requestParams: {
path: z.object({
id: ZResponseIdSchema,

4
apps/web/modules/api/v2/management/responses/lib/openapi.ts
View File

@@ -16,7 +16,7 @@ export const getResponsesEndpoint: ZodOpenApiOperationObject = {
requestParams: {
query: ZGetResponsesFilter.sourceType(),
},
tags: ["Management API > Responses"],
tags: ["Management API - Responses"],
responses: {
"200": {
description: "Responses retrieved successfully.",
@@ -33,7 +33,7 @@ export const createResponseEndpoint: ZodOpenApiOperationObject = {
operationId: "createResponse",
summary: "Create a response",
description: "Creates a response in the database.",
tags: ["Management API > Responses"],
tags: ["Management API - Responses"],
requestBody: {
required: true,
description: "The response to create",

2
apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/openapi.ts
View File

@@ -10,7 +10,7 @@ export const getPersonalizedSurveyLink: ZodOpenApiOperationObject = {
requestParams: {
path: ZContactLinkParams,
},
tags: ["Management API > Surveys > Contact Links"],
tags: ["Management API - Surveys - Contact Links"],
responses: {
"200": {
description: "Personalized survey link retrieved successfully.",

2
apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/segments/[segmentId]/lib/openapi.ts
View File

@@ -10,7 +10,7 @@ export const getContactLinksBySegmentEndpoint: ZodOpenApiOperationObject = {
operationId: "getContactLinksBySegment",
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"],
tags: ["Management API - Surveys - Contact Links"],
requestParams: {
path: ZContactLinksBySegmentParams,
query: ZContactLinksBySegmentQuery,

6
apps/web/modules/api/v2/management/surveys/[surveyId]/lib/openapi.ts
View File

@@ -13,7 +13,7 @@ export const getSurveyEndpoint: ZodOpenApiOperationObject = {
id: surveyIdSchema,
}),
},
tags: ["Management API > Surveys"],
tags: ["Management API - Surveys"],
responses: {
"200": {
description: "Response retrieved successfully.",
@@ -30,7 +30,7 @@ export const deleteSurveyEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteSurvey",
summary: "Delete a survey",
description: "Deletes a survey from the database.",
tags: ["Management API > Surveys"],
tags: ["Management API - Surveys"],
requestParams: {
path: z.object({
id: surveyIdSchema,
@@ -52,7 +52,7 @@ export const updateSurveyEndpoint: ZodOpenApiOperationObject = {
operationId: "updateSurvey",
summary: "Update a survey",
description: "Updates a survey in the database.",
tags: ["Management API > Surveys"],
tags: ["Management API - Surveys"],
requestParams: {
path: z.object({
id: surveyIdSchema,

9
apps/web/modules/api/v2/management/surveys/lib/openapi.ts
View File

@@ -1,8 +1,3 @@
// import {
// deleteSurveyEndpoint,
// getSurveyEndpoint,
// updateSurveyEndpoint,
// } from "@/modules/api/v2/management/surveys/[surveyId]/lib/openapi";
import { managementServer } from "@/modules/api/v2/management/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";
@@ -17,7 +12,7 @@ export const getSurveysEndpoint: ZodOpenApiOperationObject = {
requestParams: {
query: ZGetSurveysFilter,
},
tags: ["Management API > Surveys"],
tags: ["Management API - Surveys"],
responses: {
"200": {
description: "Surveys retrieved successfully.",
@@ -34,7 +29,7 @@ export const createSurveyEndpoint: ZodOpenApiOperationObject = {
operationId: "createSurvey",
summary: "Create a survey",
description: "Creates a survey in the database.",
tags: ["Management API > Surveys"],
tags: ["Management API - Surveys"],
requestBody: {
required: true,
description: "The survey to create",

6
apps/web/modules/api/v2/management/webhooks/[webhookId]/lib/openapi.ts
View File

@@ -14,7 +14,7 @@ export const getWebhookEndpoint: ZodOpenApiOperationObject = {
id: ZWebhookIdSchema,
}),
},
tags: ["Management API > Webhooks"],
tags: ["Management API - Webhooks"],
responses: {
"200": {
description: "Webhook retrieved successfully.",
@@ -31,7 +31,7 @@ export const deleteWebhookEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteWebhook",
summary: "Delete a webhook",
description: "Deletes a webhook from the database.",
tags: ["Management API > Webhooks"],
tags: ["Management API - Webhooks"],
requestParams: {
path: z.object({
id: ZWebhookIdSchema,
@@ -53,7 +53,7 @@ export const updateWebhookEndpoint: ZodOpenApiOperationObject = {
operationId: "updateWebhook",
summary: "Update a webhook",
description: "Updates a webhook in the database.",
tags: ["Management API > Webhooks"],
tags: ["Management API - Webhooks"],
requestParams: {
path: z.object({
id: ZWebhookIdSchema,

4
apps/web/modules/api/v2/management/webhooks/lib/openapi.ts
View File

@@ -16,7 +16,7 @@ export const getWebhooksEndpoint: ZodOpenApiOperationObject = {
requestParams: {
query: ZGetWebhooksFilter.sourceType(),
},
tags: ["Management API > Webhooks"],
tags: ["Management API - Webhooks"],
responses: {
"200": {
description: "Webhooks retrieved successfully.",
@@ -33,7 +33,7 @@ export const createWebhookEndpoint: ZodOpenApiOperationObject = {
operationId: "createWebhook",
summary: "Create a webhook",
description: "Creates a webhook in the database.",
tags: ["Management API > Webhooks"],
tags: ["Management API - Webhooks"],
requestBody: {
required: true,
description: "The webhook to create",

22
apps/web/modules/api/v2/openapi-document.ts
View File

@@ -66,43 +66,43 @@ const document = createDocument({
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 - Contact Attribute Keys",
description: "Operations for managing contact attribute keys.",
},
{
name: "Management API > Surveys",
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.",
},
],

8
apps/web/modules/api/v2/organizations/[organizationId]/project-teams/lib/openapi.ts
View File

@@ -20,7 +20,7 @@ export const getProjectTeamsEndpoint: ZodOpenApiOperationObject = {
organizationId: ZOrganizationIdSchema,
}),
},
tags: ["Organizations API > Project Teams"],
tags: ["Organizations API - Project Teams"],
responses: {
"200": {
description: "Project teams retrieved successfully.",
@@ -42,7 +42,7 @@ export const createProjectTeamEndpoint: ZodOpenApiOperationObject = {
organizationId: ZOrganizationIdSchema,
}),
},
tags: ["Organizations API > Project Teams"],
tags: ["Organizations API - Project Teams"],
requestBody: {
required: true,
description: "The project team to create",
@@ -68,7 +68,7 @@ export const deleteProjectTeamEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteProjectTeam",
summary: "Delete a project team",
description: "Deletes a project team from the database.",
tags: ["Organizations API > Project Teams"],
tags: ["Organizations API - Project Teams"],
requestParams: {
query: ZGetProjectTeamUpdateFilter.required(),
path: z.object({
@@ -91,7 +91,7 @@ export const updateProjectTeamEndpoint: ZodOpenApiOperationObject = {
operationId: "updateProjectTeam",
summary: "Update a project team",
description: "Updates a project team in the database.",
tags: ["Organizations API > Project Teams"],
tags: ["Organizations API - Project Teams"],
requestParams: {
path: z.object({
organizationId: ZOrganizationIdSchema,

6
apps/web/modules/api/v2/organizations/[organizationId]/teams/[teamId]/lib/openapi.ts
View File

@@ -16,7 +16,7 @@ export const getTeamEndpoint: ZodOpenApiOperationObject = {
organizationId: ZOrganizationIdSchema,
}),
},
tags: ["Organizations API > Teams"],
tags: ["Organizations API - Teams"],
responses: {
"200": {
description: "Team retrieved successfully.",
@@ -33,7 +33,7 @@ export const deleteTeamEndpoint: ZodOpenApiOperationObject = {
operationId: "deleteTeam",
summary: "Delete a team",
description: "Deletes a team from the database.",
tags: ["Organizations API > Teams"],
tags: ["Organizations API - Teams"],
requestParams: {
path: z.object({
id: ZTeamIdSchema,
@@ -56,7 +56,7 @@ export const updateTeamEndpoint: ZodOpenApiOperationObject = {
operationId: "updateTeam",
summary: "Update a team",
description: "Updates a team in the database.",
tags: ["Organizations API > Teams"],
tags: ["Organizations API - Teams"],
requestParams: {
path: z.object({
id: ZTeamIdSchema,

4
apps/web/modules/api/v2/organizations/[organizationId]/teams/lib/openapi.ts
View File

@@ -24,7 +24,7 @@ export const getTeamsEndpoint: ZodOpenApiOperationObject = {
}),
query: ZGetTeamsFilter.sourceType(),
},
tags: ["Organizations API > Teams"],
tags: ["Organizations API - Teams"],
responses: {
"200": {
description: "Teams retrieved successfully.",
@@ -46,7 +46,7 @@ export const createTeamEndpoint: ZodOpenApiOperationObject = {
organizationId: ZOrganizationIdSchema,
}),
},
tags: ["Organizations API > Teams"],
tags: ["Organizations API - Teams"],
requestBody: {
required: true,
description: "The team to create",

6
apps/web/modules/api/v2/organizations/[organizationId]/users/lib/openapi.ts
View File

@@ -20,7 +20,7 @@ export const getUsersEndpoint: ZodOpenApiOperationObject = {
}),
query: ZGetUsersFilter.sourceType(),
},
tags: ["Organizations API > Users"],
tags: ["Organizations API - Users"],
responses: {
"200": {
description: "Users retrieved successfully.",
@@ -42,7 +42,7 @@ export const createUserEndpoint: ZodOpenApiOperationObject = {
organizationId: ZOrganizationIdSchema,
}),
},
tags: ["Organizations API > Users"],
tags: ["Organizations API - Users"],
requestBody: {
required: true,
description: "The user to create",
@@ -73,7 +73,7 @@ export const updateUserEndpoint: ZodOpenApiOperationObject = {
organizationId: ZOrganizationIdSchema,
}),
},
tags: ["Organizations API > Users"],
tags: ["Organizations API - Users"],
requestBody: {
required: true,
description: "The user to update",

2
apps/web/modules/ee/contacts/api/v2/management/contacts/bulk/lib/openapi.ts
View File

@@ -73,7 +73,7 @@ const bulkContactEndpoint: ZodOpenApiOperationObject = {
},
},
},
tags: ["Management API > Contacts"],
tags: ["Management API - Contacts"],
responses: {
"200": {
description: "Contacts uploaded successfully.",