feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat: add get-campaigns docs - #351

Merged
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs
Feb 16, 2026
Merged

feat: add get-campaigns docs#351
KMKoushik merged 1 commit into
usesend:mainfrom
magicspon:issues-missing-get-campaigns-docs

Conversation

@magicspon

@magicsponmagicspon commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Adds the missing API reference documentation for get /v1/campaigns


Summary by cubic

Adds the missing API reference for GET /v1/campaigns with pagination, filtering, and response schema. Addresses the Linear issue about missing get-campaigns docs.

  • New Features
    • Documents GET /v1/campaigns query params: page (default 1), status (DRAFT|SCHEDULED|IN_PROGRESS|PAUSED|COMPLETED|CANCELLED), search.
    • Defines 200 response: campaigns[] with id, name, from, subject, createdAt, updatedAt, status, scheduledAt (nullable), total, sent, delivered, unsubscribed; plus totalPage.

Written for commit 1d1216a. Summary will update on new commits.

Summary by CodeRabbit

Release Notes

  • New Features
    • Added a new endpoint to list campaigns with pagination and filtering capabilities
    • Filter campaigns by status or search term to find specific campaigns
    • Campaign list includes details such as name, status, dates, and delivery metrics

@vercel

vercelBot commented Feb 10, 2026

Copy link
Copy Markdown

@magicspon is attempting to deploy a commit to the kmkoushik's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Feb 10, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

This pull request adds a new GET endpoint specification to the OpenAPI documentation for /v1/campaigns. The endpoint enables listing campaigns with support for pagination through a page parameter (default: 1), status filtering via an enum (DRAFT, SCHEDULED, IN_PROGRESS, PAUSED, COMPLETED, CANCELLED), and text-based search. The response includes a campaigns array containing campaign objects with fields such as id, name, from, subject, createdAt, updatedAt, status, scheduledAt, and delivery metrics (total, sent, delivered, unsubscribed), along with a totalPage field.

Possibly related PRs

Suggested reviewers

  • KMKoushik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main change: adding API documentation for the GET campaigns endpoint. It is specific, concise, and directly related to the changeset.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
apps/docs/api-reference/openapi.json (1)

1764-1764: Response status field lacks the enum constraint present on the query parameter.

The status query parameter (line 1722) correctly lists the enum values (DRAFT, SCHEDULED, etc.), but the status property in the response campaign object is a bare "type": "string". Adding the same enum here improves documentation for API consumers and enables better client code generation.

Proposed fix
-"status": { "type": "string" },+"status": {+ "type": "string",+ "enum": [+ "DRAFT",+ "SCHEDULED",+ "IN_PROGRESS",+ "PAUSED",+ "COMPLETED",+ "CANCELLED"+ ]+},

Note: the same bare "type": "string" pattern exists for status in the POST /v1/campaigns and GET /v1/campaigns/{campaignId} response schemas (lines 1870 and 1961), so this is a pre-existing gap — but worth fixing while you're here.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@greptile-apps

Copy link
Copy Markdown

Greptile Overview

Greptile Summary

This PR adds an OpenAPI GET /v1/campaigns operation under apps/docs/api-reference/openapi.json, documenting pagination (page), filtering (status), and search, along with a 200 response schema returning an object with campaigns[] and totalPage.

The change fits into the existing docs repo pattern where API endpoints are described directly in paths within a single OpenAPI JSON used to render the docs and drive any client/type generation.

Confidence Score: 4/5

  • Mostly safe to merge, but the OpenAPI schema has a couple mismatches that should be corrected to avoid inaccurate docs/client generation.
  • Only documentation/schema changes are included, but the page parameter is typed as a string (should be integer) and the campaign status response field lacks the enum constraints already documented elsewhere, which will lead to inconsistent API reference output and generated types.
  • apps/docs/api-reference/openapi.json

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +1712 to +1714
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong type for page

page is documented as a string ({"type":"string","default":"1"}), but it represents a page number. This will generate incorrect client types and allows non-numeric values. It should be an integer (optionally with minimum: 1) and defaults/examples should be numeric.

Suggested change
{
"schema": { "type": "string", "default": "1", "example": "1" },
"required": false,
"schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 },

Comment on lines +1764 to +1766
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enum missing for status

In the 200 response schema, each campaign’s status is currently just {"type":"string"}. Since you already define the allowed values in the status query param, leaving the response unconstrained will produce weaker/incorrect generated types and inconsistent docs. Consider adding the same enum to the response field.

Suggested change
"status": { "type": "string" },
"scheduledAt": { "type": "string", "nullable": true, "format": "date-time" },
"total": { "type": "integer" },
"status": { "type": "string", "enum": ["DRAFT","SCHEDULED","IN_PROGRESS","PAUSED","COMPLETED","CANCELLED"] },

@KMKoushik
KMKoushik merged commit 752fe5a into usesend:mainFeb 16, 2026
4 of 5 checks passed
KMKoushik pushed a commit that referenced this pull request Feb 24, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@magicspon@KMKoushik