Skip to content

Align endpoint Javadoc layout #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weppos merged 1 commit into from
Sep 18, 2026
Merged

Align endpoint Javadoc layout #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/main/java/com/dnsimple/endpoints/Billing.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ public Billing(HttpEndpointClient client) {
/**
* Lists the billing charges for the account.
*
* @param account The account ID
* @param options The options for the list request
* @return The list charges response
* @see <a href="https://developer.dnsimple.com/v2/billing-charges/#listCharges">https://developer.dnsimple.com/v2/billing-charges/#listCharges</a>
*/
public ListResponse<Charge> listCharges(Number account, ListOptions options) {
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/com/dnsimple/endpoints/Certificates.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public SimpleResponse<CertificatePrivateKey> getCertificatePrivateKey(Number acc
* @param account The account ID
* @param domain The domain name or ID
* @param options The options for the certificate purchase
* @return The Let's Encrypt purchase response
* @return The purchase Let's Encrypt certificate response
* @see <a href="https://developer.dnsimple.com/v2/certificates/#purchaseLetsencryptCertificate">https://developer.dnsimple.com/v2/certificates/#purchaseLetsencryptCertificate</a>
*/
public SimpleResponse<CertificatePurchase> purchaseLetsencryptCertificate(Number account, String domain, CertificatePurchaseOptions options) {
Expand All @@ -112,7 +112,7 @@ public SimpleResponse<CertificatePurchase> purchaseLetsencryptCertificate(Number
* @param account The account ID
* @param domain The domain name or ID
* @param certificatePurchaseId The ID of the purchase order returned by purchaseLetsencryptCertificate
* @return The Let's Encrypt issue response
* @return The issue Let's Encrypt certificate response
* @see <a href="https://developer.dnsimple.com/v2/certificates/#issueLetsencryptCertificate">https://developer.dnsimple.com/v2/certificates/#issueLetsencryptCertificate</a>
*/
public SimpleResponse<Certificate> issueLetsencryptCertificate(Number account, String domain, Number certificatePurchaseId) {
Expand All @@ -129,7 +129,7 @@ public SimpleResponse<Certificate> issueLetsencryptCertificate(Number account, S
* @param domain The domain name or ID
* @param certificateId The certificate ID
* @param options The options for the certificate renewal
* @return The Let's Encrypt purchase renewal response
* @return The purchase Let's Encrypt certificate renewal response
* @see <a href="https://developer.dnsimple.com/v2/certificates/#purchaseRenewalLetsencryptCertificate">https://developer.dnsimple.com/v2/certificates/#purchaseRenewalLetsencryptCertificate</a>
*/
public SimpleResponse<CertificateRenewal> purchaseLetsencryptCertificateRenewal(Number account, String domain, Number certificateId, CertificateRenewalPurchaseOptions options) {
Expand All @@ -146,7 +146,7 @@ public SimpleResponse<CertificateRenewal> purchaseLetsencryptCertificateRenewal(
* @param domain The domain name or ID
* @param certificateId The domain name or ID
* @param certificateRenewalId The ID of the purchase order returned by purchaseLetsencryptCertificateRenewal
* @return The Let's Encrypt issue response
* @return The issue Let's Encrypt certificate renewal response
* @see <a href="https://developer.dnsimple.com/v2/certificates/#issueRenewalLetsencryptCertificate">https://developer.dnsimple.com/v2/certificates/#issueRenewalLetsencryptCertificate</a>
*/
public SimpleResponse<Certificate> issueLetsencryptCertificateRenewal(Number account, String domain, Number certificateId, Number certificateRenewalId) {
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/dnsimple/endpoints/Contacts.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public PaginatedResponse<Contact> listContacts(Number account, ListOptions optio
* Create a contact in the account.
*
* @param account The account ID
* @param options options to create the new contact
* @param options Options to create the new contact
* @return The create contact response
* @see <a href="https://developer.dnsimple.com/v2/contacts/#createContact">https://developer.dnsimple.com/v2/contacts/#createContact</a>
*/
Expand All @@ -75,7 +75,7 @@ public SimpleResponse<Contact> getContact(Number account, Number contactId) {
*
* @param account The account ID
* @param contactId The contact ID
* @param options options to update the contact
* @param options Options to update the contact
* @return The update contact response
* @see <a href="https://developer.dnsimple.com/v2/contacts/#updateContact">https://developer.dnsimple.com/v2/contacts/#updateContact</a>
*/
Expand Down
18 changes: 9 additions & 9 deletions src/main/java/com/dnsimple/endpoints/Domains.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public EmptyResponse deleteDomain(Number account, String domain) {
*
* @param account The account ID
* @param domain The domain ID or name or name
* @return The DNSSEC enable response
* @return The enable DNSSEC response
* @see <a href="https://developer.dnsimple.com/v2/domains/dnssec/#enableDomainDnssec">https://developer.dnsimple.com/v2/domains/dnssec/#enableDomainDnssec</a>
*/
public SimpleResponse<Dnssec> enableDnssec(Number account, String domain) {
Expand All @@ -110,7 +110,7 @@ public SimpleResponse<Dnssec> enableDnssec(Number account, String domain) {
*
* @param account The account ID
* @param domain The domain ID or name or name
* @return The DNSSEC disable response
* @return The disable DNSSEC response
* @see <a href="https://developer.dnsimple.com/v2/domains/dnssec/#disableDomainDnssec">https://developer.dnsimple.com/v2/domains/dnssec/#disableDomainDnssec</a>
*/
public EmptyResponse disableDnssec(Number account, String domain) {
Expand Down Expand Up @@ -268,9 +268,9 @@ public EmptyResponse deleteEmailForward(Number account, String domain, Number em
/**
* Initiate a push using an account identifier.
*
* @param account The account ID
* @param domain The domain name or ID
* @param newAccountIdentifier The account identifier of the target account
* @param account The account ID
* @param domain The domain name or ID
* @param newAccountIdentifier The account identifier of the target account
* @return The initiate push response
* @see <a href="https://developer.dnsimple.com/v2/domains/pushes/#initiateDomainPush">https://developer.dnsimple.com/v2/domains/pushes/#initiateDomainPush</a>
*/
Expand Down Expand Up @@ -334,7 +334,7 @@ public EmptyResponse acceptPush(Number account, Number push, Number contactId) {
*
* @param account The account ID
* @param push The push ID
* @return The accept push response
* @return The reject push response
* @see <a href="https://developer.dnsimple.com/v2/domains/pushes/#rejectPush">https://developer.dnsimple.com/v2/domains/pushes/#rejectPush</a>
*/
public EmptyResponse rejectPush(Number account, Number push) {
Expand All @@ -347,9 +347,9 @@ public EmptyResponse rejectPush(Number account, Number push) {
* This endpoint provides information about a domain's availability status, including whether it's
* available for registration, already registered, or has other restrictions.
*
* @param account The account ID
* @param domainName The domain name to research
* @return The domain research status response
* @param account The account ID
* @param domainName The domain name to research
* @return The get domain research status response
* @see <a href="https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus">https://developer.dnsimple.com/v2/domains/research/#getDomainsResearchStatus</a>
*/
public SimpleResponse<DomainResearchStatus> getDomainResearchStatus(Number account, String domainName) {
Expand Down
52 changes: 24 additions & 28 deletions src/main/java/com/dnsimple/endpoints/Registrar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ public SimpleResponse<DomainCheck> checkDomain(Number account, String domainName
*
* @param account The account ID
* @param domainName The domain to check the prices
*
* @return the domain prices response
* @return The get domain prices response
* @see <a href="https://developer.dnsimple.com/v2/registrar/#getDomainPrices">https://developer.dnsimple.com/v2/registrar/#getDomainPrices</a>
*/
public SimpleResponse<DomainPrice> getDomainPrices(Number account, String domainName) {
Expand All @@ -56,8 +55,7 @@ public SimpleResponse<DomainPrice> getDomainPrices(Number account, String domain
* @param account The account ID
* @param domainName The domain to check the registration
* @param domainRegistration The domain registration ID
*
* @return the domain registration response
* @return The get domain registration response
* @see <a href="https://developer.dnsimple.com/v2/registrar/#getDomainRegistration">https://developer.dnsimple.com/v2/registrar/#getDomainRegistration</a>
*/
public SimpleResponse<DomainRegistration> getDomainRegistration(Number account, String domainName, Number domainRegistration) {
Expand All @@ -67,11 +65,10 @@ public SimpleResponse<DomainRegistration> getDomainRegistration(Number account,
/**
* Get the details of an existing domain renewal.
*
* @param account The account ID
* @param domainName The domain to check the renewal
* @param account The account ID
* @param domainName The domain to check the renewal
* @param domainRenewal The domain renewal ID
*
* @return the domain renewal response
* @return The get domain renewal response
* @see <a href="https://developer.dnsimple.com/v2/registrar/#getDomainRenewal">https://developer.dnsimple.com/v2/registrar/#getDomainRenewal</a>
*/
public SimpleResponse<DomainRenewal> getDomainRenewal(Number account, String domainName, Number domainRenewal) {
Expand All @@ -84,8 +81,7 @@ public SimpleResponse<DomainRenewal> getDomainRenewal(Number account, String dom
* @param account The account ID
* @param domain The domain name or ID
* @param domainRestore The domain restore ID
*
* @return the domain restore response
* @return The get domain restore response
* @see <a href="https://developer.dnsimple.com/v2/registrar/#getDomainRestore">https://developer.dnsimple.com/v2/registrar/#getDomainRestore</a>
*/
public SimpleResponse<DomainRestore> getDomainRestore(Number account, String domain, Number domainRestore) {
Expand Down Expand Up @@ -124,7 +120,7 @@ public SimpleResponse<DomainTransfer> transferDomain(Number account, String doma
* @param account The account ID
* @param domain The domain name or ID
* @param domainTransferId The domain transfer ID
* @return The transfer domain response
* @return The get domain transfer response
* @see <a href="https://developer.dnsimple.com/v2/registrar/#getDomainTransfer">https://developer.dnsimple.com/v2/registrar/#getDomainTransfer</a>
*/
public SimpleResponse<DomainTransfer> getDomainTransfer(Number account, String domain, Number domainTransferId) {
Expand All @@ -137,7 +133,7 @@ public SimpleResponse<DomainTransfer> getDomainTransfer(Number account, String d
* @param account The account ID
* @param domain The domain name or ID
* @param domainTransferId The domain transfer ID
* @return The transfer domain response
* @return The cancel domain transfer response
* @see <a href="https://developer.dnsimple.com/v2/registrar/#cancelDomainTransfer">https://developer.dnsimple.com/v2/registrar/#cancelDomainTransfer</a>
*/
public SimpleResponse<DomainTransfer> cancelDomainTransfer(Number account, String domain, Number domainTransferId) {
Expand Down Expand Up @@ -175,7 +171,7 @@ public SimpleResponse<DomainRestore> restoreDomain(Number account, String domain
*
* @param account The account ID
* @param domain The domain name or ID
* @return The transfer domain out response
* @return The authorize transfer out response
* @see <a href="https://developer.dnsimple.com/v2/registrar/#authorizeDomainTransferOut">https://developer.dnsimple.com/v2/registrar/#authorizeDomainTransferOut</a>
*/
public EmptyResponse authorizeTransferOut(Number account, String domain) {
Expand Down Expand Up @@ -285,7 +281,7 @@ public EmptyResponse changeDomainDelegationFromVanity(Number account, String dom
*
* @param account The account ID
* @param options List options
* @return Registrant changes
* @return The list registrant changes response
* @see <a href="https://developer.dnsimple.com/v2/registrar/registrant-changes/#listRegistrantChanges">https://developer.dnsimple.com/v2/registrar/registrant-changes/#listRegistrantChanges</a>
*/
public ListResponse<RegistrantChange> listRegistrantChanges(Number account, ListOptions options) {
Expand All @@ -296,8 +292,8 @@ public ListResponse<RegistrantChange> listRegistrantChanges(Number account, List
* Start a registrant change.
*
* @param account The account ID
* @param input The input parameters
* @return The registrant change response
* @param input The input parameters
* @return The create registrant change response
* @see <a href="https://developer.dnsimple.com/v2/registrar/registrant-changes/#createRegistrantChange">https://developer.dnsimple.com/v2/registrar/registrant-changes/#createRegistrantChange</a>
*/
public SimpleResponse<RegistrantChange> createRegistrantChange(Number account, CreateRegistrantChangeInput input) {
Expand All @@ -308,8 +304,8 @@ public SimpleResponse<RegistrantChange> createRegistrantChange(Number account, C
* Retrieves the requirements of a registrant change.
*
* @param account The account ID
* @param input The domain and contact to check
* @return The registrant change check response
* @param input The domain and contact to check
* @return The check registrant change response
* @see <a href="https://developer.dnsimple.com/v2/registrar/registrant-changes/#checkRegistrantChange">https://developer.dnsimple.com/v2/registrar/registrant-changes/#checkRegistrantChange</a>
*/
public SimpleResponse<RegistrantChangeCheck> checkRegistrantChange(Number account, CheckRegistrantChangeInput input) {
Expand All @@ -319,9 +315,9 @@ public SimpleResponse<RegistrantChangeCheck> checkRegistrantChange(Number accoun
/**
* Retrieves the details of an existing registrant change.
*
* @param account The account ID
* @param account The account ID
* @param registrantChange The registrant change
* @return The registrant change response
* @return The get registrant change response
* @see <a href="https://developer.dnsimple.com/v2/registrar/registrant-changes/#getRegistrantChange">https://developer.dnsimple.com/v2/registrar/registrant-changes/#getRegistrantChange</a>
*/
public SimpleResponse<RegistrantChange> getRegistrantChange(Number account, Number registrantChange) {
Expand All @@ -331,9 +327,9 @@ public SimpleResponse<RegistrantChange> getRegistrantChange(Number account, Numb
/**
* Cancel an ongoing registrant change from the account.
*
* @param account The account ID
* @param account The account ID
* @param registrantChange The registrant change
* @return The registrant change response
* @return The delete registrant change response
* @see <a href="https://developer.dnsimple.com/v2/registrar/registrant-changes/#deleteRegistrantChange">https://developer.dnsimple.com/v2/registrar/registrant-changes/#deleteRegistrantChange</a>
*/
public EmptyResponse deleteRegistrantChange(Number account, Number registrantChange) {
Expand All @@ -344,8 +340,8 @@ public EmptyResponse deleteRegistrantChange(Number account, Number registrantCha
* Gets the transfer lock status for a domain.
*
* @param account The account ID
* @param domain The domain name or ID
* @return The transfer lock status
* @param domain The domain name or ID
* @return The get domain transfer lock response
* @see <a href="https://developer.dnsimple.com/v2/registrar/transfer-lock/#getDomainTransferLock">https://developer.dnsimple.com/v2/registrar/transfer-lock/#getDomainTransferLock</a>
*/
public SimpleResponse<DomainTransferLock> getDomainTransferLock(Number account, String domain) {
Expand All @@ -356,8 +352,8 @@ public SimpleResponse<DomainTransferLock> getDomainTransferLock(Number account,
* Locks the domain to prevent unauthorized transfers.
*
* @param account The account ID
* @param domain The domain name or ID
* @return The transfer lock status
* @param domain The domain name or ID
* @return The enable domain transfer lock response
* @see <a href="https://developer.dnsimple.com/v2/registrar/transfer-lock/#enableDomainTransferLock">https://developer.dnsimple.com/v2/registrar/transfer-lock/#enableDomainTransferLock</a>
*/
public SimpleResponse<DomainTransferLock> enableDomainTransferLock(Number account, String domain) {
Expand All @@ -368,8 +364,8 @@ public SimpleResponse<DomainTransferLock> enableDomainTransferLock(Number accoun
* Unlocks the domain to allow domain transfers.
*
* @param account The account ID
* @param domain The domain name or ID
* @return The transfer lock status
* @param domain The domain name or ID
* @return The disable domain transfer lock response
* @see <a href="https://developer.dnsimple.com/v2/registrar/transfer-lock/#disableDomainTransferLock">https://developer.dnsimple.com/v2/registrar/transfer-lock/#disableDomainTransferLock</a>
*/
public SimpleResponse<DomainTransferLock> disableDomainTransferLock(Number account, String domain) {
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/com/dnsimple/endpoints/Tlds.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public Tlds(HttpEndpointClient client) {
/**
* Lists supported TLDs for registration
*
* @return The list tlds response
* @return The list TLDs response
* @see <a href="https://developer.dnsimple.com/v2/tlds/#listTlds">https://developer.dnsimple.com/v2/tlds/#listTlds</a>
*/
public PaginatedResponse<Tld> listTlds() {
Expand All @@ -36,7 +36,7 @@ public PaginatedResponse<Tld> listTlds() {
* Lists supported TLDs for registration
*
* @param options The options for the list request
* @return The list tlds response
* @return The list TLDs response
* @see <a href="https://developer.dnsimple.com/v2/tlds/#listTlds">https://developer.dnsimple.com/v2/tlds/#listTlds</a>
*/
public PaginatedResponse<Tld> listTlds(ListOptions options) {
Expand All @@ -47,7 +47,7 @@ public PaginatedResponse<Tld> listTlds(ListOptions options) {
* Get details for a specific tld.
*
* @param tld The TLD string (i.e. "com")
* @return The get tld response
* @return The get TLD response
* @see <a href="https://developer.dnsimple.com/v2/tlds/#getTld">https://developer.dnsimple.com/v2/tlds/#getTld</a>
*/
public SimpleResponse<Tld> getTld(String tld) {
Expand All @@ -58,7 +58,7 @@ public SimpleResponse<Tld> getTld(String tld) {
* Get extended attributes for a TLD
*
* @param tld The TLD to retrieve extended attributes for
* @return The list tlds response
* @return The get TLD extended attributes response
* @see <a href="https://developer.dnsimple.com/v2/tlds/#getTldExtendedAttributes">https://developer.dnsimple.com/v2/tlds/#getTldExtendedAttributes</a>
*/
public ListResponse<TldExtendedAttribute> getTldExtendedAttributes(String tld) {
Expand Down
Loading
Loading