Skip to content

Document Domain Research access, usage visibility, and monthly cap#1022

Merged
dallasread merged 1 commit into
mainfrom
docs/domain-research-subscription-and-usage-visibility
May 28, 2026
Merged

Document Domain Research access, usage visibility, and monthly cap#1022
dallasread merged 1 commit into
mainfrom
docs/domain-research-subscription-and-usage-visibility

Conversation

@dallasread
Copy link
Copy Markdown
Member

@dallasread dallasread commented May 25, 2026

Tightens content/v2/domains/research.md so a developer reading the page
can tell, without leaving it, that they need the Domain Research
subscription and the domain_research_read scope, where their
month-to-date usage shows up in-app, and what the cap-exceeded response
looks like.

The cap number is intentionally not published — only that a cap exists
and depends on the subscription. The shared /v2/#too-many-requests
reference already covers the body shape and X-RateLimit-* headers, so
the cap-specific Retry-After is documented in narrative only; see the
issue notes for the OpenAPI $ref reasoning.

Fixes #1021
Belongs to https://github.com/dnsimple/dnsimple-business/issues/2779

🔍 QA

📋 Deployment Pre/Post tasks

N / A

:shipit: Deployment Verification

  • production: Verify a successful deploy

@dallasread dallasread added the documentation Updates on the documentation and support content. label May 25, 2026
@dallasread dallasread self-assigned this May 25, 2026
Copy link
Copy Markdown
Contributor

@lokst lokst left a comment

Choose a reason for hiding this comment

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

This looks great, thanks!

@dallasread dallasread merged commit be1d0ad into main May 28, 2026
8 checks passed
@dallasread dallasread deleted the docs/domain-research-subscription-and-usage-visibility branch May 28, 2026 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Updates on the documentation and support content.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation for Domain Availability Check Usage Tracking

4 participants