docs(registrar): reworked registrar doc (#212)

Author: scaleway-bot

scaleway-async/scaleway_async/domain/v2beta1/api.py

@@ -1321,8 +1321,8 @@ async def list_tasks(
     ) -> ListTasksResponse:
         """
         List tasks.
-        List all account tasks.
-        You can filter the list by domain name.
+        List all operations performed on the account.
+        You can filter the list of tasks by domain name.
         :param page:
         :param page_size:
         :param project_id:
@@ -1372,8 +1372,8 @@ async def list_tasks_all(
     ) -> List[Task]:
         """
         List tasks.
-        List all account tasks.
-        You can filter the list by domain name.
+        List all operations performed on the account.
+        You can filter the list of tasks by domain name.
         :param page:
         :param page_size:
         :param project_id:
@@ -1420,9 +1420,9 @@ async def buy_domains(
         technical_contact: Optional[NewContact] = None,
     ) -> OrderResponse:
         """
-        Buy one or more domains.
+        Purchase domains.
         Request the registration of domain names.
-        You can provide an already existing domain's contact or a new contact.
+        You can provide a domain's already existing contact or a new contact.
         :param domains:
         :param duration_in_years:
         :param project_id:
@@ -1473,8 +1473,8 @@ async def renew_domains(
         force_late_renewal: Optional[bool] = None,
     ) -> OrderResponse:
         """
-        Renew one or more domains.
-        Request the renewal of domain names.
+        Renew domains.
+        Request the renewal of one or more domain names.
         :param domains:
         :param duration_in_years:
         :param force_late_renewal:
@@ -1519,7 +1519,7 @@ async def transfer_in_domain(
     ) -> OrderResponse:
         """
         Transfer a domain.
-        Request the transfer from another registrar domain to Scaleway.
+        Request the transfer of a domain from another registrar to Scaleway Domains and DNS.
         :param domains:
         :param project_id:
         :param owner_contact_id: One-of ('owner_contact_type'): at most one of 'owner_contact_id', 'owner_contact' could be set.
@@ -1566,11 +1566,11 @@ async def trade_domain(
         new_owner_contact: Optional[NewContact] = None,
     ) -> OrderResponse:
         """
-        Trade a domain contact.
-        Request a trade for the contact owner.<br/>
-        If an `organization_id` is given, the change is from the current Scaleway account to another Scaleway account.<br/>
-        If no contact is given, the first contact of the other Scaleway account is taken.<br/>
-        If the other Scaleway account has no contact. An error occurs.
+        Trade a domain's contact.
+        Request to change a domain's contact owner.<br/>
+        If you specify the `organization_id` of the domain's new owner, the contact will change from the current owner's Scaleway account to the new owner's Scaleway account.<br/>
+        If the new owner's current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change.<br/>
+        If the new owner has never created a contact to register domains before, an error message displays.
         :param domain:
         :param project_id:
         :param new_owner_contact_id: One-of ('new_owner_contact_type'): at most one of 'new_owner_contact_id', 'new_owner_contact' could be set.
@@ -1676,9 +1676,9 @@ async def check_contacts_compatibility(
         technical_contact: Optional[NewContact] = None,
     ) -> CheckContactsCompatibilityResponse:
         """
-        Check if contacts are compatible against a domain or a tld.
-        Check if contacts are compatible against a domain or a tld.
-        If not, it will return the information requiring a correction.
+        Check if contacts are compatible with a domain or a TLD.
+        Check whether contacts are compatible with a domain or a TLD.
+        If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned.
         :param domains:
         :param tlds:
         :param owner_contact_id: One-of ('owner_contact_type'): at most one of 'owner_contact_id', 'owner_contact' could be set.
@@ -1727,7 +1727,7 @@ async def list_contacts(
     ) -> ListContactsResponse:
         """
         List contacts.
-        Return a list of contacts with their domains and roles.
+        Retrieve the list of contacts and their associated domains and roles.
         You can filter the list by domain name.
         :param page:
         :param page_size:
@@ -1769,7 +1769,7 @@ async def list_contacts_all(
     ) -> List[ContactRoles]:
         """
         List contacts.
-        Return a list of contacts with their domains and roles.
+        Retrieve the list of contacts and their associated domains and roles.
         You can filter the list by domain name.
         :param page:
         :param page_size:
@@ -1804,7 +1804,7 @@ async def get_contact(
     ) -> Contact:
         """
         Get a contact.
-        Return a contact details retrieved from the registrar using a given contact ID.
+        Retrieve a contact's details from the registrar using the given contact's ID.
         :param contact_id:
         :return: :class:`Contact <Contact>`
 
@@ -1850,7 +1850,7 @@ async def update_contact(
     ) -> Contact:
         """
         Update contact.
-        You can edit the contact coordinates.
+        Edit the contact's information.
         :param contact_id:
         :param email:
         :param email_alt:
@@ -1932,7 +1932,7 @@ async def list_domains(
     ) -> ListDomainsResponse:
         """
         List domains.
-        Returns a list of domains owned by the user.
+        Retrieve the list of domains you own.
         :param page:
         :param page_size:
         :param order_by:
@@ -1985,7 +1985,7 @@ async def list_domains_all(
     ) -> List[DomainSummary]:
         """
         List domains.
-        Returns a list of domains owned by the user.
+        Retrieve the list of domains you own.
         :param page:
         :param page_size:
         :param order_by:
@@ -2030,8 +2030,8 @@ async def list_renewable_domains(
         organization_id: Optional[str] = None,
     ) -> ListRenewableDomainsResponse:
         """
-        List scaleway domains that can or not be renewed.
-        Returns a list of domains owned by the user with a renew status and if renewable, the maximum renew duration in years.
+        List domains that can be renewed.
+        Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable.
         :param page:
         :param page_size:
         :param order_by:
@@ -2071,8 +2071,8 @@ async def list_renewable_domains_all(
         organization_id: Optional[str] = None,
     ) -> List[RenewableDomain]:
         """
-        List scaleway domains that can or not be renewed.
-        Returns a list of domains owned by the user with a renew status and if renewable, the maximum renew duration in years.
+        List domains that can be renewed.
+        Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable.
         :param page:
         :param page_size:
         :param order_by:
@@ -2106,7 +2106,7 @@ async def get_domain(
     ) -> Domain:
         """
         Get domain.
-        Returns a the domain with more informations.
+        Retrieve a specific domain and display the domain's information.
         :param domain:
         :return: :class:`Domain <Domain>`
 
@@ -2170,9 +2170,9 @@ async def update_domain(
         administrative_contact: Optional[NewContact] = None,
     ) -> Domain:
         """
-        Update a domain.
-        Update the domain contacts or create a new one.<br/>
-        If you add the same contact for multiple roles. Only one ID will be created and used for all of them.
+        Update a domain's contacts.
+        Update contacts for a specific domain or create a new contact.<br/>
+        If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles.
         :param domain:
         :param technical_contact_id: One-of ('technical_contact_info'): at most one of 'technical_contact_id', 'technical_contact' could be set.
         :param technical_contact: One-of ('technical_contact_info'): at most one of 'technical_contact_id', 'technical_contact' could be set.
@@ -2216,8 +2216,8 @@ async def lock_domain_transfer(
         domain: str,
     ) -> Domain:
         """
-        Lock domain transfer.
-        Lock domain transfer. A locked domain transfer can't be transferred and the auth code can't be requested.
+        Lock the transfer of a domain.
+        Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar.
         :param domain:
         :return: :class:`Domain <Domain>`
 
@@ -2243,8 +2243,8 @@ async def unlock_domain_transfer(
         domain: str,
     ) -> Domain:
         """
-        Unlock domain transfer.
-        Unlock domain transfer. An unlocked domain can be transferred and the auth code can be requested for this.
+        Unlock the transfer of a domain.
+        Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar.
         :param domain:
         :return: :class:`Domain <Domain>`
 
@@ -2270,7 +2270,8 @@ async def enable_domain_auto_renew(
         domain: str,
     ) -> Domain:
         """
-        Enable domain auto renew.
+        Enable auto renew.
+        Enable the `auto renew` feature for a domain. This means the domain will be automatically renewed before its expiry date.
         :param domain:
         :return: :class:`Domain <Domain>`
 
@@ -2296,7 +2297,8 @@ async def disable_domain_auto_renew(
         domain: str,
     ) -> Domain:
         """
-        Disable domain auto renew.
+        Disable auto renew.
+        Disable the `auto renew` feature for a domain. This means the domain will not be renewed before its expiry date.
         :param domain:
         :return: :class:`Domain <Domain>`
 
@@ -2322,9 +2324,9 @@ async def get_domain_auth_code(
         domain: str,
     ) -> GetDomainAuthCodeResponse:
         """
-        Return domain auth code.
-        If possible, return the auth code for an unlocked domain transfer, or an error if the domain is locked.
-        Some TLD may have a different procedure to retrieve the auth code, in that case, the information is given in the message field.
+        Get a domain's authorization code.
+        Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked.
+        Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field.
         :param domain:
         :return: :class:`GetDomainAuthCodeResponse <GetDomainAuthCodeResponse>`
 
@@ -2386,7 +2388,8 @@ async def disable_domain_dnssec(
         domain: str,
     ) -> Domain:
         """
-        Disable domain DNSSEC.
+        Disable a domain's DNSSEC.
+        Disable DNSSEC for a domain.
         :param domain:
         :return: :class:`Domain <Domain>`
 
@@ -2415,9 +2418,9 @@ async def search_available_domains(
     ) -> SearchAvailableDomainsResponse:
         """
         Search available domains.
-        Search a domain (or at maximum, 10 domains).
+        Search a domain or a maximum of 10 domains that are available.
 
-        If the TLD list is empty or not set the search returns the results from the most popular TLDs.
+        If the TLD list is empty or not set, the search returns the results from the most popular TLDs.
         :param domains: A list of domain to search, TLD is optional.
         :param tlds: Array of tlds to search on.
         :param strict_search: Search exact match.
@@ -2453,7 +2456,8 @@ async def create_domain_host(
         ips: Optional[List[str]] = None,
     ) -> Host:
         """
-        Create domain hostname with glue IPs.
+        Create a hostname for a domain.
+        Create a hostname for a domain with glue IPs.
         :param domain:
         :param name:
         :param ips:
@@ -2494,7 +2498,8 @@ async def list_domain_hosts(
         page_size: Optional[int] = None,
     ) -> ListDomainHostsResponse:
         """
-        List domain hostnames with they glue IPs.
+        List a domain's hostnames.
+        List a domain's hostnames using their glue IPs.
         :param domain:
         :param page:
         :param page_size:
@@ -2528,7 +2533,8 @@ async def list_domain_hosts_all(
         page_size: Optional[int] = None,
     ) -> List[Host]:
         """
-        List domain hostnames with they glue IPs.
+        List a domain's hostnames.
+        List a domain's hostnames using their glue IPs.
         :param domain:
         :param page:
         :param page_size:
@@ -2559,7 +2565,8 @@ async def update_domain_host(
         ips: Optional[List[str]] = None,
     ) -> Host:
         """
-        Update domain hostname with glue IPs.
+        Update a domain's hostname.
+        Update a domain's hostname with glue IPs.
         :param domain:
         :param name:
         :param ips:
@@ -2600,7 +2607,8 @@ async def delete_domain_host(
         name: str,
     ) -> Host:
         """
-        Delete domain hostname.
+        Delete a domain's hostname.
+        Delete a domain's hostname.
         :param domain:
         :param name:
         :return: :class:`Host <Host>`