refactor: allow total_count and remaining_count of pagination results to be null

[jason-rl]

User description

⚠️ PR Title Must Follow Conventional Commits

Format: feat[optional scope]: <description>

Examples: feat: add new SDK method · feat(storage): support file uploads · feat!: breaking API change

---

Description

Motivation

Changes

Testing

• Unit tests added
• Integration tests added
• Smoke Tests added/updated
• Tested locally

Breaking Changes

Checklist

• PR title follows Conventional Commits format (feat: or feat(scope):)
• Documentation updated (if needed)
• Breaking changes documented (if applicable)

---

CodeAnt-AI Description

Return null for deprecated total_count and remaining_count in list and pagination responses

What Changed

• List endpoints and pagination page responses now use null for total_count and remaining_count when a count is not provided instead of returning 0.
• Many list view types now document these fields as deprecated and explicitly indicate they always return null.
• SDK pagination page objects set their total_count fields to null when the server omits a count, so client code will observe null rather than 0.

Impact

✅ Clearer pagination counts in list responses
✅ Fewer misleading zero totals in paginated lists
✅ Explicit deprecation of remaining_count/total_count for clients

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

[codeant-ai]

CodeAnt AI is reviewing your PR.

---

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

[codeant-ai]

Nitpicks 🔍

🔒 No security issues identified

⚡ Recommended areas for review Breaking Type Change Many page response interfaces and page classes changed total_count from number to number | null and constructors now set this.total_count = body.total_count ?? null. This turns previous implicit/default numeric values (e.g., 0) into null and may break any consumer code that assumes total_count is always a number and performs arithmetic (sum, comparison) without null checks. Verify all callers and downstream code that read total_count are updated to handle null or migrate them to use a safe helper. API compatibility Pagination counts were changed from number to number | null. Consumers (and internal pagination helper code) that perform arithmetic or rely on a numeric value may now receive null and produce runtime issues. Verify client-side normalization, TypeScript usages, and downstream callers handle null correctly. Pagination contract change The types for remaining_count and total_count were widened to number | null. This is a runtime contract change (null may be returned). Verify clients that consume these fields can handle null safely (particularly code that assumes numeric values). Deprecated-but-present fields remaining_count and total_count are present and documented as "Deprecated: always returns null." Confirm that the API indeed always returns null and that keeping these fields (nullable but required) matches the intended compatibility strategy. Consider making them optional or removing them entirely if planned. Inconsistent handling of counts remaining_count and total_count are now nullable in ScenarioDefinitionListView. Ensure other list views and pagination utilities treat these fields consistently (either all nullable or normalized), and update any logic that assumes a non-null numeric value.

[codeant-ai]

CodeAnt AI finished reviewing your PR.