Update openAPI integration, add endpoints#37
Open
kschneider84 wants to merge 18 commits into
Open
Conversation
Contributor
|
Important Review skippedToo many files! This PR contains 276 files, which is 126 over the limit of 150. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (276)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR migrates API documentation rendering from a custom Swagger UI wrapper to the Fumadocs OpenAPI integration, adds a script-driven OpenAPI → MDX generation workflow, and expands/organizes the generated endpoint pages for the Management API, Participant API, and SMTP Bridge docs.
Changes:
- Add OpenAPI doc generation tooling (
scripts/generate-docs.ts,scripts/doc-profiles.ts) and update README instructions. - Integrate
fumadocs-openapiinto the Fumadocs sources and MDX component registry (APIPage). - Replace/remove prior Swagger UI-based approach and add many generated OpenAPI endpoint pages + sidebar metadata.
Reviewed changes
Copilot reviewed 270 out of 277 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tsconfig.json | Update TS JSX mode and path aliases for Fumadocs collections. |
| scripts/generate-docs.ts | Add OpenAPI→MDX generation script (profile-driven). |
| scripts/doc-profiles.ts | Define OpenAPI docs generation profiles. |
| README.md | Document new OpenAPI docs workflow and generator commands. |
| public/openapi/smtp-bridge.json | Remove old public JSON OpenAPI spec. |
| package.json | Bump Fumadocs/Next/tooling deps; add fumadocs-openapi. |
| openapi/smtp-bridge.yaml | Add YAML OpenAPI spec for SMTP Bridge. |
| mdx-components.tsx | Register APIPage MDX component for OpenAPI pages. |
| lib/source-tech-docs.ts | Switch to Fumadocs collections + enable OpenAPI plugin for tech-docs. |
| lib/source-docs.ts | Switch to Fumadocs collections + enable OpenAPI plugin for docs. |
| lib/openapi.ts | Add OpenAPI loader helper + export shared openapi instance. |
| content/tech-docs/smtp-bridge/meta.json | Replace placeholder description. |
| content/tech-docs/smtp-bridge/api/sendEmail.mdx | Generated SMTP Bridge endpoint page. |
| content/tech-docs/smtp-bridge/api/meta.json | Generated SMTP Bridge API sidebar metadata. |
| content/tech-docs/smtp-bridge/api/index.mdx | Generated SMTP Bridge API index page. |
| content/tech-docs/smtp-bridge/api/getHealth.mdx | Generated SMTP Bridge health endpoint page. |
| content/tech-docs/smtp-bridge/api.mdx | Remove old placeholder API landing page. |
| content/tech-docs/participant-api/meta.json | Replace placeholder description. |
| content/tech-docs/participant-api/api/user/updateProfile.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/updatePreferredLanguage.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/updateContactPreferences.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/setUserAttribute.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/requestPhoneNumberVerification.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/removeProfile.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/meta.json | Generated Participant API “User” section metadata. |
| content/tech-docs/participant-api/api/user/getUserAttributes.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/getUser.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/deleteUserAttribute.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/deleteUser.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/changePhoneNumber.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/changePassword.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/changeAccountEmail.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/user/addProfile.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/studies/studyHasCodeListCode.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/studies/meta.json | Generated Participant API “Studies” section metadata. |
| content/tech-docs/participant-api/api/studies/getStudyVariables.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/studies/getStudyVariable.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/studies/getStudyCodeListAvailableCount.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/studies/getStudy.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/studies/getStudiesByStatus.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/studies/getParticipatingStudies.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/password/resetPassword.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/password/meta.json | Generated Participant API “Password” section metadata. |
| content/tech-docs/participant-api/api/password/initiatePasswordReset.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/password/getPasswordResetInfos.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/uploadParticipantFile.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/meta.json | Generated Participant API “Participant data” section metadata. |
| content/tech-docs/participant-api/api/participant-data/listParticipantFiles.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getVirtualParticipantsByLinkingCode.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getTempParticipantSurveyWithContext.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getTempParticipantSurveys.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getSurveyWithContext.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getSubmissionHistory.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getStudyResponsesForProfile.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getReports.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getParticipantState.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getParticipantFile.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getLinkingCode.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getConfidentialResponse.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/getAssignedSurveys.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/participant-data/deleteParticipantFile.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/misc/unsubscribeNewsletter.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/misc/meta.json | Generated Participant API “Misc” section metadata. |
| content/tech-docs/participant-api/api/misc/getHealth.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/meta.json | Generated Participant API root API metadata. |
| content/tech-docs/participant-api/api/index.mdx | Generated Participant API index page. |
| content/tech-docs/participant-api/api/events/submitTempParticipantResponse.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/events/submitSurveyEvent.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/events/registerTempParticipant.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/events/meta.json | Generated Participant API “Events” section metadata. |
| content/tech-docs/participant-api/api/events/mergeVirtualParticipant.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/events/mergeTempParticipant.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/events/leaveStudyEvent.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/events/enterStudy.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/events/customStudyEvent.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/verifyOTP.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/verifyEmail.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/validateToken.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/signupWithEmail.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/revokeTokens.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/resendEmailVerification.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/requestOTP.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/renewToken.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/meta.json | Generated Participant API “Auth” section metadata. |
| content/tech-docs/participant-api/api/auth/logout.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/loginWithTempToken.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/loginWithEmail.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api/auth/getTempTokenInfo.mdx | Generated Participant API endpoint page. |
| content/tech-docs/participant-api/api.mdx | Remove old placeholder API landing page. |
| content/tech-docs/management-api/api/user-management/userManagement_updatePermissionLimiter.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/userManagement_requestParticipantUserDeletion.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/userManagement_listUserPermissions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/userManagement_listManagementUsers.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/userManagement_getManagementUser.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/userManagement_deleteUserPermission.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/userManagement_deleteManagementUser.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/userManagement_addPermissionToUser.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/user-management/meta.json | Generated Management API “User management” section metadata. |
| content/tech-docs/management-api/api/surveys/surveys_updateSurvey.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/surveys_unpublishSurvey.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/surveys_listSurveyVersions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/surveys_listSurveyInfos.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/surveys_getSurveyVersion.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/surveys_getLatestSurvey.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/surveys_deleteSurveyVersion.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/surveys_createSurvey.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/surveys/meta.json | Generated Management API “Surveys” section metadata. |
| content/tech-docs/management-api/api/study-variables/studyVariables_updateVariableValue.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-variables/studyVariables_updateVariableDef.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-variables/studyVariables_listVariables.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-variables/studyVariables_getVariable.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-variables/studyVariables_deleteVariable.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-variables/studyVariables_addVariable.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-variables/meta.json | Generated Management API “Study variables” section metadata. |
| content/tech-docs/management-api/api/study-rules/studyRules_publishNewVersion.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-rules/studyRules_listVersions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-rules/studyRules_getVersion.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-rules/studyRules_getCurrent.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-rules/studyRules_deleteVersion.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-rules/meta.json | Generated Management API “Study rules” section metadata. |
| content/tech-docs/management-api/api/study-permissions/studyPermissions_removePermission.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-permissions/studyPermissions_listPermissions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-permissions/studyPermissions_addPermission.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-permissions/meta.json | Generated Management API “Study permissions” section metadata. |
| content/tech-docs/management-api/api/study-counters/studyCounters_saveValue.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-counters/studyCounters_removeValue.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-counters/studyCounters_listValues.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-counters/studyCounters_incrementValue.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/study-counters/meta.json | Generated Management API “Study counters” section metadata. |
| content/tech-docs/management-api/api/studies/studies_updateStatus.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_updateIsDefault.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_updateFileUploadRule.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_updateDisplayProps.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_listStudies.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_getStudy.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_exportConfig.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_deleteStudy.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/studies_createStudy.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/studies/meta.json | Generated Management API “Studies” section metadata. |
| content/tech-docs/management-api/api/service-accounts/userManagement_updateServiceAccountPermissionLimiter.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_updateServiceAccount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_listServiceAccounts.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_listServiceAccountPermissions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_listServiceAccountAPIKeys.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_getServiceAccount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_deleteServiceAccountPermission.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_deleteServiceAccountAPIKey.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_deleteServiceAccount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_createServiceAccountAPIKey.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_createServiceAccount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/userManagement_addPermissionToServiceAccount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/service-accounts/meta.json | Generated Management API “Service accounts” section metadata. |
| content/tech-docs/management-api/api/responses/meta.json | Generated Management API “Responses” section metadata. |
| content/tech-docs/management-api/api/responses/dataExporter_listDailyResponseExports.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_listConfidentialResponseExports.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_getSurveyInfo.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_getResponsesTaskStatus.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_getResponsesTaskResult.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_getResponsesCount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_getDailyResponseExport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_getConfidentialResponses.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_getConfidentialResponseExport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExporter_generateResponsesExport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExplorer_listResponses.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExplorer_getResponse.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExplorer_deleteResponses.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/responses/dataExplorer_deleteResponse.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/participants_updateParticipantReport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/participants_submitParticipantReport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/meta.json | Generated Management API “Reports” section metadata. |
| content/tech-docs/management-api/api/reports/dataExporter_getReportsTaskStatus.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/dataExporter_getReportsTaskResult.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/dataExporter_getReportsCount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/dataExporter_generateReportsExport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/dataExplorer_listReports.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/dataExplorer_listReportKeys.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/reports/dataExplorer_getReport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/participants_submitParticipantResponse.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/participants_submitParticipantEvent.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/participants_removeStudySession.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/participants_mergeParticipants.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/participants_listParticipantResponses.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/participants_editParticipant.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/participants_createVirtualParticipant.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/meta.json | Generated Management API “Participants” section metadata. |
| content/tech-docs/management-api/api/participants/dataExporter_getParticipantsTaskStatus.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/dataExporter_getParticipantsTaskResult.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/dataExporter_getParticipantsCount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/dataExporter_generateParticipantsExport.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/dataExplorer_listParticipants.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/participants/dataExplorer_getParticipant.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/notifications/notifications_updateSubscriptions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/notifications/notifications_getSubscriptions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/notifications/meta.json | Generated Management API “Notifications” section metadata. |
| content/tech-docs/management-api/api/meta.json | Generated Management API root API metadata. |
| content/tech-docs/management-api/api/messaging/meta.json | Generated Management API “Messaging” section metadata. |
| content/tech-docs/management-api/api/messaging/messaging_saveStudyEmailTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_saveSmsTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_saveGlobalEmailTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_listStudyEmailTemplates.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_listScheduledEmails.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_listGlobalEmailTemplates.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_listAllStudyEmailTemplates.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_getStudyEmailTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_getSmsTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_getScheduledEmail.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_getGlobalEmailTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_deleteStudyEmailTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_deleteScheduledEmail.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_deleteGlobalEmailTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/messaging/messaging_createScheduledEmail.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/files/meta.json | Generated Management API “Files” section metadata. |
| content/tech-docs/management-api/api/files/dataExplorer_listFiles.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/files/dataExplorer_getFile.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/files/dataExplorer_deleteFile.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/code-lists/meta.json | Generated Management API “Code lists” section metadata. |
| content/tech-docs/management-api/api/code-lists/codeLists_removeCode.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/code-lists/codeLists_getListKeys.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/code-lists/codeLists_getCodes.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/code-lists/codeLists_addCodes.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/auth/meta.json | Generated Management API “Auth” section metadata. |
| content/tech-docs/management-api/api/auth/auth_signinWithIdp.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/auth/auth_renewToken.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/auth/auth_listPermissions.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/auth/auth_extendSession.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_updateAppRoleTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_removeUserAppRole.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_listUserAppRoles.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_listAppRoleTemplates.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_listAppRoles.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_getAppRoleTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_deleteAppRoleTemplatesForApp.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_deleteAppRoleTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_deleteAppRolesForApp.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_createAppRoleTemplate.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/userManagement_addAppRoleToUser.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/app-roles/meta.json | Generated Management API “App roles” section metadata. |
| content/tech-docs/management-api/api/actions/meta.json | Generated Management API “Actions” section metadata. |
| content/tech-docs/management-api/api/actions/actions_runPrevResponsesOnParticipants.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/actions/actions_runPrevResponsesOnParticipant.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/actions/actions_runOnParticipants.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/actions/actions_runOnParticipant.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/actions/actions_getTaskStatus.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/actions/actions_getTaskResult.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/actions/actions_getPrevResponsesTaskStatus.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/actions/actions_getPrevResponsesTaskResult.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/accounts/updateStudyTrackAccount.mdx | Generated Management API endpoint page. |
| content/tech-docs/management-api/api/accounts/meta.json | Generated Management API “Accounts” section metadata. |
| content/tech-docs/management-api/api.mdx | Remove old placeholder API landing page. |
| content/docs/survey-editor/meta.json | Add explicit pages list for survey editor docs section. |
| content/docs/survey-editor/item-structure.mdx | Fix internal links + image paths for new structure. |
| content/docs/survey-editor/guides/setup-survey.mdx | Fix internal links for new structure. |
| content/docs/survey-editor/guides/edit-survey.mdx | Fix internal links for new structure. |
| content/docs/survey-editor/guides/add-single-choice.mdx | Fix internal links for new structure. |
| content/docs/survey-editor/guides/add-date-constraints.mdx | Fix internal links for new structure. |
| content/docs/survey-editor/guides/add-conditional-question.mdx | Fix internal links for new structure. |
| content/docs/survey-editor/editor-overview.mdx | Rename/retitle and fix relative image paths + links. |
| content/docs/survey-editor/basics/meta.json | Remove obsolete basics section metadata. |
| content/docs/study-rules-editor/meta.json | Add explicit pages list for study rules editor docs section. |
| content/docs/study-rules-editor/guide/entry-handler.mdx | Fix internal links for new structure. |
| content/docs/study-rules-editor/editor-overview.mdx | Rename/retitle and fix relative image paths + links. |
| content/docs/study-rules-editor/basics/meta.json | Remove obsolete basics section metadata. |
| components/api-page.tsx | Add shared APIPage component via fumadocs-openapi UI. |
| components/api-page.client.tsx | Add fumadocs-openapi client config entrypoint. |
| components/api-doc.tsx | Remove Swagger UI wrapper component. |
| app/tech-docs/[[...slug]]/page.tsx | Remove Swagger UI special-casing for /api routes. |
| app/global.css | Switch theme preset + include openapi preset + layout tweaks. |
| app/docs/[[...slug]]/page.tsx | Minor formatting change (no logic change). |
| app/(home)/page.tsx | Update home page links to new docs routes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
27
to
+30
| "@types/react": "^19.2.2", | ||
| "@types/react-dom": "^19.2.2", | ||
| "@types/swagger-ui-react": "^5.18.0", | ||
| "eslint": "^8", | ||
| "eslint-config-next": "15.3.4", | ||
| "eslint": "^10.0.2", |
| @@ -0,0 +1,13 @@ | |||
| import { createOpenAPI } from 'fumadocs-openapi/server'; | |||
|
|
|||
| export const defaultOpenAPIInput = './openapi/management-api.yaml'; | |||
Comment on lines
+1
to
+4
| import { docs } from 'fumadocs-mdx:collections/server'; | ||
| import { loader, multiple } from 'fumadocs-core/source'; | ||
| import { lucideIconsPlugin } from 'fumadocs-core/source/lucide-icons'; | ||
| import { openapiPlugin, openapiSource } from 'fumadocs-openapi/server'; |
Contributor
Author
|
coderabbit review --type committed |
Contributor
Author
|
@coderabbitai review but ignore generated OpenAPI files in case-docs/content/tech-docs |
Contributor
|
✅ Action performedReview finished.
|
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
-update fumadocs Version
-remove swagger ui, use fumadocs openApi integration
-add missing endpoints