diff --git a/apps/web/modules/api/v2/management/contact-attribute-keys/[contactAttributeKeyId]/lib/openapi.ts b/apps/web/modules/api/v2/management/contact-attribute-keys/[contactAttributeKeyId]/lib/openapi.ts index bd9bd0d3a7..d4eee3481b 100644 --- a/apps/web/modules/api/v2/management/contact-attribute-keys/[contactAttributeKeyId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/contact-attribute-keys/[contactAttributeKeyId]/lib/openapi.ts @@ -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, diff --git a/apps/web/modules/api/v2/management/contact-attribute-keys/lib/openapi.ts b/apps/web/modules/api/v2/management/contact-attribute-keys/lib/openapi.ts index c8d2094059..760c7d949c 100644 --- a/apps/web/modules/api/v2/management/contact-attribute-keys/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/contact-attribute-keys/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/api/v2/management/contact-attributes/[contactAttributeId]/lib/openapi.ts b/apps/web/modules/api/v2/management/contact-attributes/[contactAttributeId]/lib/openapi.ts index 40ae2a16e4..55821104b5 100644 --- a/apps/web/modules/api/v2/management/contact-attributes/[contactAttributeId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/contact-attributes/[contactAttributeId]/lib/openapi.ts @@ -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(), diff --git a/apps/web/modules/api/v2/management/contact-attributes/lib/openapi.ts b/apps/web/modules/api/v2/management/contact-attributes/lib/openapi.ts index f7ff2af820..59c1222dcd 100644 --- a/apps/web/modules/api/v2/management/contact-attributes/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/contact-attributes/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/api/v2/management/contacts/[contactId]/lib/openapi.ts b/apps/web/modules/api/v2/management/contacts/[contactId]/lib/openapi.ts index 481f37d53f..bdcc05648a 100644 --- a/apps/web/modules/api/v2/management/contacts/[contactId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/contacts/[contactId]/lib/openapi.ts @@ -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(), diff --git a/apps/web/modules/api/v2/management/contacts/lib/openapi.ts b/apps/web/modules/api/v2/management/contacts/lib/openapi.ts index 7ba8f433e1..0d4dddc070 100644 --- a/apps/web/modules/api/v2/management/contacts/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/contacts/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/api/v2/management/responses/[responseId]/lib/openapi.ts b/apps/web/modules/api/v2/management/responses/[responseId]/lib/openapi.ts index c91a2fc836..cfe5da2bef 100644 --- a/apps/web/modules/api/v2/management/responses/[responseId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/responses/[responseId]/lib/openapi.ts @@ -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, diff --git a/apps/web/modules/api/v2/management/responses/lib/openapi.ts b/apps/web/modules/api/v2/management/responses/lib/openapi.ts index 62ee0c87cb..b99eafae66 100644 --- a/apps/web/modules/api/v2/management/responses/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/responses/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/openapi.ts b/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/openapi.ts index cd24956cb3..96c2049fa5 100644 --- a/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/contacts/[contactId]/lib/openapi.ts @@ -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.", diff --git a/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/segments/[segmentId]/lib/openapi.ts b/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/segments/[segmentId]/lib/openapi.ts index efefb35025..6ef2540bd8 100644 --- a/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/segments/[segmentId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/surveys/[surveyId]/contact-links/segments/[segmentId]/lib/openapi.ts @@ -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, diff --git a/apps/web/modules/api/v2/management/surveys/[surveyId]/lib/openapi.ts b/apps/web/modules/api/v2/management/surveys/[surveyId]/lib/openapi.ts index 7b124889ca..f218a40725 100644 --- a/apps/web/modules/api/v2/management/surveys/[surveyId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/surveys/[surveyId]/lib/openapi.ts @@ -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, diff --git a/apps/web/modules/api/v2/management/surveys/lib/openapi.ts b/apps/web/modules/api/v2/management/surveys/lib/openapi.ts index 29e99fe501..5239f3d981 100644 --- a/apps/web/modules/api/v2/management/surveys/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/surveys/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/api/v2/management/webhooks/[webhookId]/lib/openapi.ts b/apps/web/modules/api/v2/management/webhooks/[webhookId]/lib/openapi.ts index 43eb2ce696..2790d0b8c7 100644 --- a/apps/web/modules/api/v2/management/webhooks/[webhookId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/webhooks/[webhookId]/lib/openapi.ts @@ -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, diff --git a/apps/web/modules/api/v2/management/webhooks/lib/openapi.ts b/apps/web/modules/api/v2/management/webhooks/lib/openapi.ts index 377c262f3c..8d78d56472 100644 --- a/apps/web/modules/api/v2/management/webhooks/lib/openapi.ts +++ b/apps/web/modules/api/v2/management/webhooks/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/api/v2/openapi-document.ts b/apps/web/modules/api/v2/openapi-document.ts index dd9a34bfbc..a754323d97 100644 --- a/apps/web/modules/api/v2/openapi-document.ts +++ b/apps/web/modules/api/v2/openapi-document.ts @@ -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.", }, ], diff --git a/apps/web/modules/api/v2/organizations/[organizationId]/project-teams/lib/openapi.ts b/apps/web/modules/api/v2/organizations/[organizationId]/project-teams/lib/openapi.ts index 283023aaf6..910f701e17 100644 --- a/apps/web/modules/api/v2/organizations/[organizationId]/project-teams/lib/openapi.ts +++ b/apps/web/modules/api/v2/organizations/[organizationId]/project-teams/lib/openapi.ts @@ -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, diff --git a/apps/web/modules/api/v2/organizations/[organizationId]/teams/[teamId]/lib/openapi.ts b/apps/web/modules/api/v2/organizations/[organizationId]/teams/[teamId]/lib/openapi.ts index 18bd73ed56..8460a33702 100644 --- a/apps/web/modules/api/v2/organizations/[organizationId]/teams/[teamId]/lib/openapi.ts +++ b/apps/web/modules/api/v2/organizations/[organizationId]/teams/[teamId]/lib/openapi.ts @@ -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, diff --git a/apps/web/modules/api/v2/organizations/[organizationId]/teams/lib/openapi.ts b/apps/web/modules/api/v2/organizations/[organizationId]/teams/lib/openapi.ts index f92910e592..da641c289c 100644 --- a/apps/web/modules/api/v2/organizations/[organizationId]/teams/lib/openapi.ts +++ b/apps/web/modules/api/v2/organizations/[organizationId]/teams/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/api/v2/organizations/[organizationId]/users/lib/openapi.ts b/apps/web/modules/api/v2/organizations/[organizationId]/users/lib/openapi.ts index 1289dcf996..966f1e4440 100644 --- a/apps/web/modules/api/v2/organizations/[organizationId]/users/lib/openapi.ts +++ b/apps/web/modules/api/v2/organizations/[organizationId]/users/lib/openapi.ts @@ -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", diff --git a/apps/web/modules/ee/contacts/api/v2/management/contacts/bulk/lib/openapi.ts b/apps/web/modules/ee/contacts/api/v2/management/contacts/bulk/lib/openapi.ts index bbcfec3bf2..d6ca656a74 100644 --- a/apps/web/modules/ee/contacts/api/v2/management/contacts/bulk/lib/openapi.ts +++ b/apps/web/modules/ee/contacts/api/v2/management/contacts/bulk/lib/openapi.ts @@ -73,7 +73,7 @@ const bulkContactEndpoint: ZodOpenApiOperationObject = { }, }, }, - tags: ["Management API > Contacts"], + tags: ["Management API - Contacts"], responses: { "200": { description: "Contacts uploaded successfully.", diff --git a/apps/web/scripts/merge-client-endpoints.ts b/apps/web/scripts/merge-client-endpoints.ts index d654d33666..e29c632f2c 100644 --- a/apps/web/scripts/merge-client-endpoints.ts +++ b/apps/web/scripts/merge-client-endpoints.ts @@ -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", diff --git a/docs/README.md b/docs/README.md index 8b054108a8..91c95bea24 100644 --- a/docs/README.md +++ b/docs/README.md @@ -35,4 +35,4 @@ The documentation will be available at `http://localhost:3000`. - If Mintlify dev isn't running, try `mintlify install` to reinstall dependencies - If a page loads as a 404, ensure you're in the `docs` folder with the `mint.json` file -- For other issues, please check our [Contributing Guidelines](./CONTRIBUTING.md) +- For other issues, please check our [Contributing Guidelines](https://github.com/formbricks/formbricks/blob/main/CONTRIBUTING.md) diff --git a/docs/api-reference/client-api->-display/create-display.mdx b/docs/api-reference/client-api--display/create-display.mdx similarity index 100% rename from docs/api-reference/client-api->-display/create-display.mdx rename to docs/api-reference/client-api--display/create-display.mdx diff --git a/docs/api-reference/client-api->-display/update-display.mdx b/docs/api-reference/client-api--display/update-display.mdx similarity index 100% rename from docs/api-reference/client-api->-display/update-display.mdx rename to docs/api-reference/client-api--display/update-display.mdx diff --git a/docs/api-reference/client-api->-people/create-person.mdx b/docs/api-reference/client-api--people/create-person.mdx similarity index 100% rename from docs/api-reference/client-api->-people/create-person.mdx rename to docs/api-reference/client-api--people/create-person.mdx diff --git a/docs/api-reference/client-api->-people/update-person.mdx b/docs/api-reference/client-api--people/update-person.mdx similarity index 100% rename from docs/api-reference/client-api->-people/update-person.mdx rename to docs/api-reference/client-api--people/update-person.mdx diff --git a/docs/api-reference/client-api->-response/create-response.mdx b/docs/api-reference/client-api--response/create-response.mdx similarity index 100% rename from docs/api-reference/client-api->-response/create-response.mdx rename to docs/api-reference/client-api--response/create-response.mdx diff --git a/docs/api-reference/client-api->-response/update-response.mdx b/docs/api-reference/client-api--response/update-response.mdx similarity index 100% rename from docs/api-reference/client-api->-response/update-response.mdx rename to docs/api-reference/client-api--response/update-response.mdx diff --git a/docs/api-reference/management-api->-action-class/create-action-class.mdx b/docs/api-reference/management-api--action-class/create-action-class.mdx similarity index 100% rename from docs/api-reference/management-api->-action-class/create-action-class.mdx rename to docs/api-reference/management-api--action-class/create-action-class.mdx diff --git a/docs/api-reference/management-api->-action-class/delete-action-class.mdx b/docs/api-reference/management-api--action-class/delete-action-class.mdx similarity index 100% rename from docs/api-reference/management-api->-action-class/delete-action-class.mdx rename to docs/api-reference/management-api--action-class/delete-action-class.mdx diff --git a/docs/api-reference/management-api->-action-class/get-action-class-by-id.mdx b/docs/api-reference/management-api--action-class/get-action-class-by-id.mdx similarity index 100% rename from docs/api-reference/management-api->-action-class/get-action-class-by-id.mdx rename to docs/api-reference/management-api--action-class/get-action-class-by-id.mdx diff --git a/docs/api-reference/management-api->-action-class/get-all-action-classes.mdx b/docs/api-reference/management-api--action-class/get-all-action-classes.mdx similarity index 100% rename from docs/api-reference/management-api->-action-class/get-all-action-classes.mdx rename to docs/api-reference/management-api--action-class/get-all-action-classes.mdx diff --git a/docs/api-reference/management-api->-attribute-class/create-attribute-class.mdx b/docs/api-reference/management-api--attribute-class/create-attribute-class.mdx similarity index 100% rename from docs/api-reference/management-api->-attribute-class/create-attribute-class.mdx rename to docs/api-reference/management-api--attribute-class/create-attribute-class.mdx diff --git a/docs/api-reference/management-api->-attribute-class/delete-attribute-class.mdx b/docs/api-reference/management-api--attribute-class/delete-attribute-class.mdx similarity index 100% rename from docs/api-reference/management-api->-attribute-class/delete-attribute-class.mdx rename to docs/api-reference/management-api--attribute-class/delete-attribute-class.mdx diff --git a/docs/api-reference/management-api->-attribute-class/get-all-attribute-classes.mdx b/docs/api-reference/management-api--attribute-class/get-all-attribute-classes.mdx similarity index 100% rename from docs/api-reference/management-api->-attribute-class/get-all-attribute-classes.mdx rename to docs/api-reference/management-api--attribute-class/get-all-attribute-classes.mdx diff --git a/docs/api-reference/management-api->-attribute-class/get-attribute-class-by-id.mdx b/docs/api-reference/management-api--attribute-class/get-attribute-class-by-id.mdx similarity index 100% rename from docs/api-reference/management-api->-attribute-class/get-attribute-class-by-id.mdx rename to docs/api-reference/management-api--attribute-class/get-attribute-class-by-id.mdx diff --git a/docs/api-reference/management-api->-contact-attribute-keys/get-all-contact-attribute-keys.mdx b/docs/api-reference/management-api--contact-attribute-keys/get-all-contact-attribute-keys.mdx similarity index 100% rename from docs/api-reference/management-api->-contact-attribute-keys/get-all-contact-attribute-keys.mdx rename to docs/api-reference/management-api--contact-attribute-keys/get-all-contact-attribute-keys.mdx diff --git a/docs/api-reference/management-api->-contact-attribute-keys/get-contact-attribute-key-by-id.mdx b/docs/api-reference/management-api--contact-attribute-keys/get-contact-attribute-key-by-id.mdx similarity index 100% rename from docs/api-reference/management-api->-contact-attribute-keys/get-contact-attribute-key-by-id.mdx rename to docs/api-reference/management-api--contact-attribute-keys/get-contact-attribute-key-by-id.mdx diff --git a/docs/api-reference/management-api->-contact-attributes/get-all-contact-attributes.mdx b/docs/api-reference/management-api--contact-attributes/get-all-contact-attributes.mdx similarity index 100% rename from docs/api-reference/management-api->-contact-attributes/get-all-contact-attributes.mdx rename to docs/api-reference/management-api--contact-attributes/get-all-contact-attributes.mdx diff --git a/docs/api-reference/management-api->-contacts/get-all-contacts.mdx b/docs/api-reference/management-api--contacts/get-all-contacts.mdx similarity index 100% rename from docs/api-reference/management-api->-contacts/get-all-contacts.mdx rename to docs/api-reference/management-api--contacts/get-all-contacts.mdx diff --git a/docs/api-reference/management-api->-contacts/get-contact-by-id.mdx b/docs/api-reference/management-api--contacts/get-contact-by-id.mdx similarity index 100% rename from docs/api-reference/management-api->-contacts/get-contact-by-id.mdx rename to docs/api-reference/management-api--contacts/get-contact-by-id.mdx diff --git a/docs/api-reference/management-api->-me/me.mdx b/docs/api-reference/management-api--me/me.mdx similarity index 100% rename from docs/api-reference/management-api->-me/me.mdx rename to docs/api-reference/management-api--me/me.mdx diff --git a/docs/api-reference/management-api->-people/delete-person.mdx b/docs/api-reference/management-api--people/delete-person.mdx similarity index 100% rename from docs/api-reference/management-api->-people/delete-person.mdx rename to docs/api-reference/management-api--people/delete-person.mdx diff --git a/docs/api-reference/management-api->-people/get-all-persons.mdx b/docs/api-reference/management-api--people/get-all-persons.mdx similarity index 100% rename from docs/api-reference/management-api->-people/get-all-persons.mdx rename to docs/api-reference/management-api--people/get-all-persons.mdx diff --git a/docs/api-reference/management-api->-people/get-person-by-id.mdx b/docs/api-reference/management-api--people/get-person-by-id.mdx similarity index 100% rename from docs/api-reference/management-api->-people/get-person-by-id.mdx rename to docs/api-reference/management-api--people/get-person-by-id.mdx diff --git a/docs/api-reference/management-api->-response/create-response.mdx b/docs/api-reference/management-api--response/create-response.mdx similarity index 100% rename from docs/api-reference/management-api->-response/create-response.mdx rename to docs/api-reference/management-api--response/create-response.mdx diff --git a/docs/api-reference/management-api->-response/delete-response.mdx b/docs/api-reference/management-api--response/delete-response.mdx similarity index 100% rename from docs/api-reference/management-api->-response/delete-response.mdx rename to docs/api-reference/management-api--response/delete-response.mdx diff --git a/docs/api-reference/management-api->-response/get-response-by-id.mdx b/docs/api-reference/management-api--response/get-response-by-id.mdx similarity index 100% rename from docs/api-reference/management-api->-response/get-response-by-id.mdx rename to docs/api-reference/management-api--response/get-response-by-id.mdx diff --git a/docs/api-reference/management-api->-response/get-survey-responses.mdx b/docs/api-reference/management-api--response/get-survey-responses.mdx similarity index 100% rename from docs/api-reference/management-api->-response/get-survey-responses.mdx rename to docs/api-reference/management-api--response/get-survey-responses.mdx diff --git a/docs/api-reference/management-api->-response/update-response.mdx b/docs/api-reference/management-api--response/update-response.mdx similarity index 100% rename from docs/api-reference/management-api->-response/update-response.mdx rename to docs/api-reference/management-api--response/update-response.mdx diff --git a/docs/api-reference/management-api->-storage/upload-public-file-local-storage.mdx b/docs/api-reference/management-api--storage/upload-public-file-local-storage.mdx similarity index 100% rename from docs/api-reference/management-api->-storage/upload-public-file-local-storage.mdx rename to docs/api-reference/management-api--storage/upload-public-file-local-storage.mdx diff --git a/docs/api-reference/management-api->-storage/upload-public-file.mdx b/docs/api-reference/management-api--storage/upload-public-file.mdx similarity index 100% rename from docs/api-reference/management-api->-storage/upload-public-file.mdx rename to docs/api-reference/management-api--storage/upload-public-file.mdx diff --git a/docs/api-reference/management-api->-survey/create-survey.mdx b/docs/api-reference/management-api--survey/create-survey.mdx similarity index 100% rename from docs/api-reference/management-api->-survey/create-survey.mdx rename to docs/api-reference/management-api--survey/create-survey.mdx diff --git a/docs/api-reference/management-api->-survey/delete-survey.mdx b/docs/api-reference/management-api--survey/delete-survey.mdx similarity index 100% rename from docs/api-reference/management-api->-survey/delete-survey.mdx rename to docs/api-reference/management-api--survey/delete-survey.mdx diff --git a/docs/api-reference/management-api->-survey/get-all-surveys.mdx b/docs/api-reference/management-api--survey/get-all-surveys.mdx similarity index 100% rename from docs/api-reference/management-api->-survey/get-all-surveys.mdx rename to docs/api-reference/management-api--survey/get-all-surveys.mdx diff --git a/docs/api-reference/management-api->-survey/get-singleuse-links.mdx b/docs/api-reference/management-api--survey/get-singleuse-links.mdx similarity index 100% rename from docs/api-reference/management-api->-survey/get-singleuse-links.mdx rename to docs/api-reference/management-api--survey/get-singleuse-links.mdx diff --git a/docs/api-reference/management-api->-survey/get-survey-by-id.mdx b/docs/api-reference/management-api--survey/get-survey-by-id.mdx similarity index 100% rename from docs/api-reference/management-api->-survey/get-survey-by-id.mdx rename to docs/api-reference/management-api--survey/get-survey-by-id.mdx diff --git a/docs/api-reference/management-api->-survey/update-survey.mdx b/docs/api-reference/management-api--survey/update-survey.mdx similarity index 100% rename from docs/api-reference/management-api->-survey/update-survey.mdx rename to docs/api-reference/management-api--survey/update-survey.mdx diff --git a/docs/api-reference/management-api->-webhook/create-webhook.mdx b/docs/api-reference/management-api--webhook/create-webhook.mdx similarity index 100% rename from docs/api-reference/management-api->-webhook/create-webhook.mdx rename to docs/api-reference/management-api--webhook/create-webhook.mdx diff --git a/docs/api-reference/management-api->-webhook/delete-webhook.mdx b/docs/api-reference/management-api--webhook/delete-webhook.mdx similarity index 100% rename from docs/api-reference/management-api->-webhook/delete-webhook.mdx rename to docs/api-reference/management-api--webhook/delete-webhook.mdx diff --git a/docs/api-reference/management-api->-webhook/get-all-webhooks.mdx b/docs/api-reference/management-api--webhook/get-all-webhooks.mdx similarity index 100% rename from docs/api-reference/management-api->-webhook/get-all-webhooks.mdx rename to docs/api-reference/management-api--webhook/get-all-webhooks.mdx diff --git a/docs/api-reference/management-api->-webhook/get-webhook.mdx b/docs/api-reference/management-api--webhook/get-webhook.mdx similarity index 100% rename from docs/api-reference/management-api->-webhook/get-webhook.mdx rename to docs/api-reference/management-api--webhook/get-webhook.mdx diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json index 19f380656a..2d19f3885d 100644 --- a/docs/api-reference/openapi.json +++ b/docs/api-reference/openapi.json @@ -225,7 +225,7 @@ } }, "summary": "Update Contact (Attributes)", - "tags": ["Client API > Contacts"] + "tags": ["Client API - Contacts"] } }, "/api/v1/client/{environmentId}/displays": { @@ -423,7 +423,7 @@ } }, "summary": "Create Display", - "tags": ["Client API > Display"] + "tags": ["Client API - Display"] } }, "/api/v1/client/{environmentId}/displays/{displayId}": { @@ -627,7 +627,7 @@ } }, "summary": "Update Display", - "tags": ["Client API > Display"] + "tags": ["Client API - Display"] } }, "/api/v1/client/{environmentId}/environment": { @@ -1045,7 +1045,7 @@ } }, "summary": "Get Environment State", - "tags": ["Client API > Environment"] + "tags": ["Client API - Environment"] } }, "/api/v1/client/{environmentId}/identify/contacts/{userId}": { @@ -1219,7 +1219,7 @@ } }, "summary": "Get Contact State", - "tags": ["Client API > Contacts"] + "tags": ["Client API - Contacts"] } }, "/api/v1/client/{environmentId}/responses": { @@ -1509,7 +1509,7 @@ } }, "summary": "Create Response", - "tags": ["Client API > Response"] + "tags": ["Client API - Response"] } }, "/api/v1/client/{environmentId}/responses/{responseId}": { @@ -1711,7 +1711,7 @@ } }, "summary": "Update Response", - "tags": ["Client API > Response"] + "tags": ["Client API - Response"] } }, "/api/v1/client/{environmentId}/user": { @@ -2121,7 +2121,7 @@ } }, "summary": "Create or Identify User", - "tags": ["Client API > User"] + "tags": ["Client API - User"] } }, "/api/v1/management/action-classes": { @@ -2314,7 +2314,7 @@ } }, "summary": "Get All Action Classes", - "tags": ["Management API > Action Class"] + "tags": ["Management API - Action Class"] }, "post": { "description": "Create Action Class from the UI or from the API! You can read more about them [here](https://formbricks.com/docs/in-app-surveys/actions).", @@ -2467,7 +2467,7 @@ } }, "summary": "Create Action Class", - "tags": ["Management API > Action Class"] + "tags": ["Management API - Action Class"] } }, "/api/v1/management/action-classes/{actionClassId}": { @@ -2676,7 +2676,7 @@ } }, "summary": "Delete Action Class", - "tags": ["Management API > Action Class"] + "tags": ["Management API - Action Class"] }, "get": { "description": "Fetch an Action Class by it's ID", @@ -2830,7 +2830,7 @@ } }, "summary": "Get Action Class by ID", - "tags": ["Management API > Action Class"] + "tags": ["Management API - Action Class"] } }, "/api/v1/management/attribute-classes": { @@ -2968,7 +2968,7 @@ } }, "summary": "Get All Attribute Classes", - "tags": ["Management API > Attribute Class"] + "tags": ["Management API - Attribute Class"] }, "post": { "description": "Create a new Attribute Class by passing in its type as well as the name! Now just use them in your app and pass this value with a user & it'll be associated with it.", @@ -3119,7 +3119,7 @@ } }, "summary": "Create Attribute Class", - "tags": ["Management API > Attribute Class"] + "tags": ["Management API - Attribute Class"] } }, "/api/v1/management/attribute-classes/{attributeClassId}": { @@ -3328,7 +3328,7 @@ } }, "summary": "Delete Attribute Class", - "tags": ["Management API > Attribute Class"] + "tags": ["Management API - Attribute Class"] }, "get": { "description": "Fetches an Attribute Class by its ID", @@ -3541,7 +3541,7 @@ } }, "summary": "Get Attribute Class by ID", - "tags": ["Management API > Attribute Class"] + "tags": ["Management API - Attribute Class"] } }, "/api/v1/management/contact-attribute-keys": { @@ -3624,7 +3624,7 @@ } }, "summary": "Get All Contact Attribute Keys", - "tags": ["Management API > Contact Attribute Keys"] + "tags": ["Management API - Contact Attribute Keys"] } }, "/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}": { @@ -3775,7 +3775,7 @@ } }, "summary": "Get Contact Attribute Key by ID", - "tags": ["Management API > Contact Attribute Keys"] + "tags": ["Management API - Contact Attribute Keys"] } }, "/api/v1/management/contact-attributes": { @@ -3855,7 +3855,7 @@ } }, "summary": "Get All Contact Attributes", - "tags": ["Management API > Contact Attributes"] + "tags": ["Management API - Contact Attributes"] } }, "/api/v1/management/contacts": { @@ -3941,7 +3941,7 @@ } }, "summary": "Get All Contacts", - "tags": ["Management API > Contacts"] + "tags": ["Management API - Contacts"] } }, "/api/v1/management/contacts/{contactId}": { @@ -4045,7 +4045,7 @@ } }, "summary": "Get Contact by ID", - "tags": ["Management API > Contacts"] + "tags": ["Management API - Contacts"] } }, "/api/v1/management/me": { @@ -4124,7 +4124,7 @@ } }, "summary": "Me", - "tags": ["Management API > Me"] + "tags": ["Management API - Me"] } }, "/api/v1/management/people": { @@ -4251,7 +4251,7 @@ } }, "summary": "Get All Persons", - "tags": ["Management API > People"] + "tags": ["Management API - People"] } }, "/api/v1/management/people/{personId}": { @@ -4400,7 +4400,7 @@ } }, "summary": "Delete Person", - "tags": ["Management API > People"] + "tags": ["Management API - People"] }, "get": { "description": "Get a person by their internal ID on Formbricks. This internal ID can be found from the Get All Person endpoint.", @@ -4493,7 +4493,7 @@ } }, "summary": "Get Person by ID", - "tags": ["Management API > People"] + "tags": ["Management API - People"] } }, "/api/v1/management/responses": { @@ -4926,7 +4926,7 @@ } }, "summary": "Get Survey Responses", - "tags": ["Management API > Response"] + "tags": ["Management API - Response"] }, "post": { "description": "Create a user response using the management API", @@ -5114,7 +5114,7 @@ } }, "summary": "Create Response", - "tags": ["Management API > Response"] + "tags": ["Management API - Response"] } }, "/api/v1/management/responses/{responseId}": { @@ -5291,7 +5291,7 @@ } }, "summary": "Delete Response", - "tags": ["Management API > Response"] + "tags": ["Management API - Response"] }, "get": { "description": "Fetch the entire response object based on its ID", @@ -5466,7 +5466,7 @@ } }, "summary": "Get Response by ID", - "tags": ["Management API > Response"] + "tags": ["Management API - Response"] }, "put": { "description": "Update an existing user response with new data", @@ -5664,7 +5664,7 @@ } }, "summary": "Update Response", - "tags": ["Management API > Response"] + "tags": ["Management API - Response"] } }, "/api/v1/management/storage": { @@ -5820,7 +5820,7 @@ } }, "summary": "Upload Public File", - "tags": ["Management API > Storage"] + "tags": ["Management API - Storage"] } }, "/api/v1/management/storage/local": { @@ -6001,7 +6001,7 @@ } ], "summary": "Upload Public File to Local Storage", - "tags": ["Management API > Storage"] + "tags": ["Management API - Storage"] } }, "/api/v1/management/surveys": { @@ -6191,7 +6191,7 @@ } }, "summary": "Get All Surveys", - "tags": ["Management API > Survey"] + "tags": ["Management API - Survey"] }, "post": { "description": "Create a survey with granular settings, questions, their types, welcomeCard, thankYouCard, languages, etc right from this API. We'd however recommend you to do this via our Formbricks App with the UI for a better visual experience.", @@ -6568,7 +6568,7 @@ } }, "summary": "Create Survey", - "tags": ["Management API > Survey"] + "tags": ["Management API - Survey"] } }, "/api/v1/management/surveys/{surveyId}": { @@ -6826,7 +6826,7 @@ } }, "summary": "Delete Survey", - "tags": ["Management API > Survey"] + "tags": ["Management API - Survey"] }, "get": { "description": "Fetch a survey object based on its ID", @@ -7020,7 +7020,7 @@ } }, "summary": "Get Survey by ID", - "tags": ["Management API > Survey"] + "tags": ["Management API - Survey"] }, "put": { "description": "Update an existing survey with new properties. This is also what we'd recommend you to do from the UI for a better visual feedback.", @@ -7279,7 +7279,7 @@ } }, "summary": "Update Survey", - "tags": ["Management API > Survey"] + "tags": ["Management API - Survey"] } }, "/api/v1/management/surveys/{surveyId}/singleUseIds": { @@ -7461,7 +7461,7 @@ } }, "summary": "Get SingleUse Links", - "tags": ["Management API > Survey"] + "tags": ["Management API - Survey"] } }, "/api/v1/webhooks": { @@ -7566,7 +7566,7 @@ } }, "summary": "Get All Webhooks", - "tags": ["Management API > Webhook"] + "tags": ["Management API - Webhook"] }, "post": { "description": "Create a new webhook right from the API and see it active right away!", @@ -7664,7 +7664,7 @@ } }, "summary": "Create Webhook", - "tags": ["Management API > Webhook"] + "tags": ["Management API - Webhook"] } }, "/api/v1/webhooks/{webhookId}": { @@ -7821,7 +7821,7 @@ } }, "summary": "Delete Webhook", - "tags": ["Management API > Webhook"] + "tags": ["Management API - Webhook"] }, "get": { "description": "Get a specific webhook object based on its ID", @@ -7914,7 +7914,7 @@ } }, "summary": "Get Webhook", - "tags": ["Management API > Webhook"] + "tags": ["Management API - Webhook"] } }, "/health": { @@ -8078,23 +8078,23 @@ }, { "description": "Displays are metrics used to measure the number of times a survey was viewed both by unidentified or identified users.", - "name": "Client API > Display" + "name": "Client API - Display" }, { "description": "Responses are captured whenever a user fills in your survey either partially or completely.", - "name": "Client API > Response" + "name": "Client API - Response" }, { "description": "Get the environment state to be used in Formbricks SDKs", - "name": "Client API > Environment" + "name": "Client API - Environment" }, { "description": "Contacts are the identified users on Formbricks app that get initated when you pass a userId and have user activation enabled. This now allows you to track & show them targeted surveys based on their attributes, device type, etc.", - "name": "Client API > Contacts" + "name": "Client API - Contacts" }, { "description": "Users are the identified users on Formbricks app that get initated when you pass a userId and have user activation enabled. This now allows you to track & show them targeted surveys based on their attributes, device type, etc. Currently, this api is only being used in the react-native sdk.", - "name": "Client API > User" + "name": "Client API - User" }, { "description": "The Management API provides access to all data and settings that are visible in the Formbricks App. This API requires a personal API Key for authentication, which can be generated in the Settings section of the Formbricks App. With the Management API, you can manage your Formbricks account programmatically, accessing and modifying data and settings as needed.\n\n> **For Auth:** we use the `x-api-key` header \n \n\nAPI requests made to the Management API are authorized using a personal API key. This key grants the same rights and access as if you were logged in at formbricks.com. It's essential to keep your API key secure and not share it with others.\n\nTo generate, store, or delete an API key, follow the instructions provided on the following page [API Key](https://formbricks.com/docs/api/management/api-key-setup).", @@ -8102,43 +8102,43 @@ }, { "description": "Action Classes allow you to set behaviour methods such as when a user clicks on a buy now button, or when a user leaves the page, etc. These allow you to trigger specific surveys to these users.\n\nMethods: Get All, Get, Create, Update, and Delete Action Classes", - "name": "Management API > Action Class" + "name": "Management API - Action Class" }, { "description": "Attribute Classes help you categorize attributes so that you can target users based on specific values of their attributes. They are associated with a Person. Read more [here](https://formbricks.com/docs/in-app-surveys/attributes)", - "name": "Management API > Attribute Class" + "name": "Management API - Attribute Class" }, { "description": "The Contacts API allows you to retrieve information about contacts in your environment. Contacts represent users who have interacted with your surveys or forms.", - "name": "Management API > Contacts" + "name": "Management API - Contacts" }, { "description": "The Contact Attributes API allows you to retrieve information about attributes associated with contacts in your environment. These attributes can include custom properties and values assigned to your contacts.", - "name": "Management API > Contact Attributes" + "name": "Management API - Contact Attributes" }, { "description": "The Contact Attribute Keys API allows you to retrieve information about the defined attribute keys in your environment. These keys define the structure and properties that can be assigned to contacts, such as email, name, or custom attributes.", - "name": "Management API > Contact Attribute Keys" + "name": "Management API - Contact Attribute Keys" }, { "description": "Retrieve Account Information", - "name": "Management API > Me" + "name": "Management API - Me" }, { "description": "Enable User Identification in Formbricks to granularly target users to show surveys to without spraying across them. This API will help you utilise Formbricks User Identification to its maximum.\n\nMethods: Get All, Get, and Delete Persons", - "name": "Management API > People" + "name": "Management API - People" }, { "description": "Responses are what your users fill in as answers to a survey. Use this cautiosly and make sure you handle this data carefully.\n\nMethods allowed: Get All, Get by Survey, Get, Update, and Delete Responses", - "name": "Management API > Response" + "name": "Management API - Response" }, { "description": "Surveys are the core of user data & feedback collection. We have various types of surveys to cater to you:\n\n- In-App Surveys\n \n- Website Surveys\n \n- Link Surveys\n \n\nCreate surveys & then trigger them as per your actions & attribute filterings that you have set to make the most of them.\n\nMethods allowed: Get All, Get, Create, Update, and Delete Surveys", - "name": "Management API > Survey" + "name": "Management API - Survey" }, { "description": "Formbricks' Webhook API offers a powerful interface for interacting with webhooks. Webhooks allow you to receive real-time HTTP notifications of changes to specific objects in the Formbricks environment.\n\nThe behavior of the webhooks is determined by their trigger settings. The trigger determines which updates the webhook sends. Current available triggers include:\n\n- \"responseCreated\"\n \n- \"responseUpdated\", and\n \n- \"responseFinished\".\n \n\nThese APIs are designed to facilitate seamless integration of Formbricks with third-party systems. By making use of our webhook API, you can automate the process of sending data to these systems whenever significant events occur within your Formbricks environment.\n\n \n\nMethods allowed: Get All, Get ,Create, and Delete Webhooks", - "name": "Management API > Webhook" + "name": "Management API - Webhook" } ] } diff --git a/docs/api-reference/rest-api.mdx b/docs/api-reference/rest-api.mdx index 49aa236fad..54625d561f 100644 --- a/docs/api-reference/rest-api.mdx +++ b/docs/api-reference/rest-api.mdx @@ -14,11 +14,9 @@ The **Public Client API** is used by our SDKs and doesn’t require authenticati We currently have the following Client API methods exposed and below is their documentation attached in Postman: -- [Displays API](/api-reference/client-api->-display/create-display) - Mark a survey as displayed or link a display to a response for a person. +- [Displays API](/api-reference/client-api--display/create-display) - Mark a survey as displayed or link a display to a response for a person. -- [Contacts API](/api-reference/client-api->-contacts/update-contact-attributes) - Update contact attributes. - -- [Responses API](/api-reference/client-api->-response/create-response) - Create & Update a Response for a Survey. +- [Responses API](/api-reference/client-api--response/create-response) - Create & Update a Response for a Survey. ## Management API @@ -26,19 +24,19 @@ The **Management API** gives full access to all data and settings available in y We currently have the following Management API methods exposed and below is their documentation attached in Postman: -- [Action Class API](/api-reference/management-api->-action-class/get-all-action-classes) - Create, List, and Delete Action Classes +- [Action Class API](/api-reference/management-api--action-class/get-all-action-classes) - Create, List, and Delete Action Classes -- [Attribute Class API ](/api-reference/management-api->-attribute-class/get-all-attribute-classes)- Create, List, and Delete Attribute Classes +- [Attribute Class API ](/api-reference/management-api--attribute-class/get-all-attribute-classes)- Create, List, and Delete Attribute Classes -- [Me API](/api-reference/management-api->-me/me) - Retrieve Account Information +- [Me API](/api-reference/management-api--me/me) - Retrieve Account Information -- [People API](/api-reference/management-api->-people/get-all-persons) - List and Delete People +- [People API](/api-reference/management-api--people/get-all-persons) - List and Delete People -- [Response API](/api-reference/management-api->-response/get-survey-responses) - List, List by Survey, Update, and Delete Responses +- [Response API](/api-reference/management-api--response/get-survey-responses) - List, List by Survey, Update, and Delete Responses -- [Survey API](/api-reference/management-api->-survey/get-all-surveys) - List, Create, Update, generate multiple suId, and Delete Surveys +- [Survey API](/api-reference/management-api--survey/get-all-surveys) - List, Create, Update, generate multiple suId, and Delete Surveys -- [Webhook API](/api-reference/management-api->-webhook/get-all-webhooks) - List, Create, and Delete Webhooks +- [Webhook API](/api-reference/management-api--webhook/get-all-webhooks) - List, Create, and Delete Webhooks diff --git a/docs/api-v2-reference/openapi.yml b/docs/api-v2-reference/openapi.yml index 89bec239d9..65b317ecf4 100644 --- a/docs/api-v2-reference/openapi.yml +++ b/docs/api-v2-reference/openapi.yml @@ -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.
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.
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.
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 diff --git a/docs/xm-and-surveys/surveys/question-type/select-multiple.mdx b/docs/xm-and-surveys/surveys/question-type/select-multiple.mdx index 80c6e5ae78..bb5c56df71 100644 --- a/docs/xm-and-surveys/surveys/question-type/select-multiple.mdx +++ b/docs/xm-and-surveys/surveys/question-type/select-multiple.mdx @@ -37,4 +37,4 @@ Provide an optional description with further instructions. Define the options shown in the list. These represent the items for which users will select. -Other than the fact that respondents can select multiple options, multi select questions are similar to [single select](/xm-and-surveys/core-features/question-type/select-single) questions. +Other than the fact that respondents can select multiple options, multi select questions are similar to [single select](/xm-and-surveys/surveys/question-type/select-single) questions. diff --git a/docs/xm-and-surveys/xm/best-practices/docs-feedback.mdx b/docs/xm-and-surveys/xm/best-practices/docs-feedback.mdx index a67c60b3f0..f42c17cc6e 100644 --- a/docs/xm-and-surveys/xm/best-practices/docs-feedback.mdx +++ b/docs/xm-and-surveys/xm/best-practices/docs-feedback.mdx @@ -250,7 +250,7 @@ return ( ## 3. Connecting to the Formbricks API -The last step is to hook up your new frontend to the Formbricks API. To achieve that, we followed the “[Create Response](/api-reference/client-api->-response/create-response)” and “[Update Response](/api-reference/client-api->-response/update-response)” pages in our docs. +The last step is to hook up your new frontend to the Formbricks API. To achieve that, we followed the “[Create Response](/api-reference/client-api--response/create-response)” and “[Update Response](/api-reference/client-api--response/update-response)” pages in our docs. Here is the code for the `handleFeedbackSubmit` function with comments: