[ECW-9115] docs: document ICANN contact updates on registered domains - #258
Open
sudoryan wants to merge 1 commit into
Open
[ECW-9115] docs: document ICANN contact updates on registered domains#258sudoryan wants to merge 1 commit into
sudoryan wants to merge 1 commit into
Conversation
The Contact Roles section implied the registrant was set only at
registration, and the update example showed just admin/tech/billing.
Partners reading it concluded a wrong registrant could not be corrected
via the API, when PATCH /domains/{name}/dns/contacts has always accepted
all four roles.
- Show `owner` in the update example and state that every role can be
changed after registration
- Note preview mode, the returned operation, and that omitted roles are
left unchanged
- Call out that no bulk form exists yet
- Add a section on registrant changes: `owner` becomes required for
tokenized domains pending verification, the other roles then default
to the registrant, DNS records may be cleared, and the domain reports
REVERIFICATION_REQUIRED until reverified (DNS calls fail with
UNVERIFIED_DNS_REGISTRANT meanwhile)
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
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.
What/Why/How?
ECW-9115 was raised as "Reseller/Partner API has no endpoint to update ICANN contacts on existing domains". Investigating the gateway showed the endpoint already exists and is already exposed to partners —
PATCH /domains/{name}/dns/contactsis in the reseller OpenAPI spec,DOMAIN_ICANN_CONTACT_UPDATEis in the default partner permission set, and E2E coverage exercises it against an activeREGISTEREDdomain.The real gap was this guide. It described the registrant as "Set during registration via the
ownerfield" and its update example showed onlyadmin/tech/billing. A partner reading it reasonably concludes a wrong registrant is permanent — which is exactly the situation in the originating support ticket, where a reseller's domains carry incorrect registrant emails and ICANN verification notices reach the wrong party.Changes to
apis/reseller/implementation-guide.md:owneradded to the update example, and the section retitled to say plainly that all four roles can be changed after registration.idor inline fields,$preview=truevalidates without applying, and the returned operation must reach a terminal state before the change is complete.ownerbecomes required, omitted roles default to the new registrant, DNS records may be cleared per the domain's retention mode, and the domain reportsregistration.icann.ownershipVerification: REVERIFICATION_REQUIRED— during which DNS calls fail withUNVERIFIED_DNS_REGISTRANT(400).Every claim was verified against the gateway implementation rather than the previous docs text.
Reference
Testing
Documentation only — no code paths changed. Behaviour described was verified against
registrar-platform(icann-contact-operation.provider.ts,domains-dns-contacts.controller.ts,operation.error.filter.ts) and against the generated reseller OpenAPI spec.Check yourself
Security