docs(partner-sdk): pages contradict each other on which fields accept -1 for unlimited
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 2
- Avg merge
- 5h 41m
- Merged PRs (30d)
- 5
Description
Summary
The partner SDK reference pages disagree with each other about which numeric entitlement fields
accept -1 as an "unlimited" sentinel. A reader following one page gets a different mental model
than a reader following another.
The contradiction
docs/SDKs/partner-go.md:693 states it exclusively:
Every counter except
CurrentAICreditsfloors at0. OnlyCurrentAICreditsaccepts-1, meaning unlimited.
But docs/SDKs/partner-javascript.md:617 and docs/SDKs/partner-python.md:605 both document
a second field as accepting it:
maxUsers| number | Maximum users allowed (-1 = unlimited)
Both cannot be right. Testing against a live API confirms the Go page is the inaccurate one — at least
one field besides CurrentAICredits accepts -1 and returns 200.
The gap
Separately, no page states which numeric fields reject -1. maxStorage is documented only as:
maxStorage| number | Maximum storage in bytes
That line is not wrong, and no example tells a reader to send maxStorage: -1 — so nothing published
is actively broken. But given that neighbouring fields in the same table are annotated
(-1 = unlimited), a reader can reasonably infer the sentinel is universal across the numeric
entitlements. It is not: sending -1 for storage fails.
Suggested fix
Make the unlimited-sentinel rule explicit and consistent across all six partner SDK pages
(partner-{javascript,python,go,php,java,ruby}.md):
- State per-field, in the entitlements table, whether
-1is accepted — rather than annotating
some fields and leaving others ambiguous. - Correct the blanket claim in
partner-go.md:693. - Explicitly note the fields where
-1is not valid, so the omission reads as deliberate
rather than as an oversight.
Happy to supply the verified per-field matrix once the API side confirms the intended semantics —
there's a corresponding API-side issue open to pin those down.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the entitlement tables in docs/SDKs/partner-javascript.md, partner-python.md, partner-go.md, partner-php.md, partner-java.md, and partner-ruby.md, along with the corresponding API-side issue. Confirm the per-field -1 behavior, then make the six pages consistent, correct the Go blanket claim, and explicitly identify fields where -1 is invalid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, java, javascript, php, python, ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100