Sync fluent crm rest api documentation#66
Open
saikatCdas wants to merge 23 commits into
Open
Conversation
Add docs and OpenAPI spec for a new POST /templates/built-in-template endpoint (operationId: getBuiltInTemplate) that fetches and normalizes a remote built-in FluentCRM template. Creates openapi JSON (src/public/openapi/templates/get-built-in-template.json) and a doc page (src/rest-api/operations/templates/get-built-in-template.md), adds a sidebar link, and updates the REST API overview counts in src/rest-api/index.md to reflect the new endpoint.
Introduce Email Patterns endpoints and docs. Added OpenAPI JSON specs for list, list (WP format), list categories, create (standard & WP format), create category, get, update, delete, delete category, and bulk-action. Added corresponding REST operation markdown files and updated the REST API sidebar to include the new Email Patterns section and links. Also updated rest-api/index.md to reference the new docs.
Add OpenAPI JSON specs and REST API docs for new Reports endpoints, and update VitePress navigation. Files added include OpenAPI specs under src/public/openapi/reports (automation reports, automation step report, campaign options, campaigns list, contacts by country/lists/status/tags, email unsubscribe stats, recent tags) and matching operation markdown files under src/rest-api/operations/reports. Also update src/.vitepress/sidebars/rest-api.js to expose the new report routes and modify src/rest-api/index.md. These changes provide request/response schemas, examples, and parameters (pagination, date ranges, etc.) to document the new Reports API surface.
Add Fetch Built-in Template API docs
Add Email Patterns REST API docs
Add Reports OpenAPI specs and docs
add AI settings, test, and generate endpoint docs
bounce handler added in docs
…d-sequence-email-delay-patch-and-pro-top-campaigns-report
…y-patch-and-pro-top-campaigns-report add sequence email delay patch and pro top campaigns report
add pro subscribers export GET and POST endpoints
…paigns-unSchedule
campaigns unSchedule added in doc
Deploying fluent-crm-developers-docs with
|
| Latest commit: |
e4e8c6d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6d0c4bde.fluent-crm-developers-docs.pages.dev |
| Branch Preview URL: | https://sync-fluent-crm-rest-api-doc.fluent-crm-developers-docs.pages.dev |
saikatCdas
commented
Apr 28, 2026
Collaborator
Author
saikatCdas
left a comment
saikatCdas
left a comment
There was a problem hiding this comment.
Review: Sync fluent-crm-rest-api-documentation → master
This is the integration PR consolidating PRs #58-65. Reviewed it end-to-end.
Global counts verified: CORRECT
| Before | After | Change | |
|---|---|---|---|
| Total endpoints | 319 | 350 | +31 |
| Modules | 28 | 31 | +3 |
| Templates | 11 | 12 | +1 |
| Email Patterns | — | 11 | new |
| Sequences | 18 | 19 | +1 |
| Reports | 14 | 25 | +11 |
| AI | — | 4 | new |
| SMS | 24 | 25 | +1 |
| Subscribers Export | — | 2 | new |
All numbers add up. (Reports: 14 + 10 from PR#60 + 1 Top Campaigns from PR#63 = 25 ✓)
PR#64 issues are fixed in this branch
Both issues flagged in my PR#64 review are resolved here:
sort_typenow has"enum": ["ASC", "DESC"]in both GET and POST subscribers-export specsadvanced_filtersinpost-subscribers-export-page.jsonnow has"type": "string"
One carry-over issue: Email Patterns response codes
From PR#59, still unresolved. Within src/public/openapi/email-patterns/:
create-email-pattern.json→422for validation errors ✓bulk-action-email-patterns.json→400create-email-pattern-category.json→400create-email-pattern-wp-format.json→400
The rest of the codebase uses 422 for POST validation failures. Recommend standardizing the three 400 files to 422 before this merges to master.
Everything else looks good
- Bounce handler
ANYbadge andoneOfresponse schema (PR#62): correct - AI endpoints (PR#61): clean, consistent
422throughout - Built-in template endpoint (PR#58): good error detail
- SMS un-schedule legacy route (PR#65): correct counts, correct response codes
- All markdown pages present for every new sidebar entry
- Sidebar badge types follow established conventions throughout
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
1 participant
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.
No description provided.