chore: adjust comment formatting (#215)

Author: scaleway-bot

packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts

@@ -56,7 +56,8 @@ const jsonContentHeaders = {
  * Get set to explore, learn and build on a dedicated Mac mini M1 with more
  * performance and speed than you ever thought possible.
  *
- * _Apple silicon as a Service comes with a minimum allocation period of 24 hours_*.
+ * _Apple silicon as a Service comes with a minimum allocation period of 24
+ * hours_*.
  *
  * Mac mini and macOS are trademarks of Apple Inc., registered in the U.S. and
  * other countries and regions. IOS is a trademark or registered trademark of

packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts

@@ -151,7 +151,10 @@ export type ListServersRequest = {
   organizationId?: string
   /** A positive integer to choose the page to return */
   page?: number
-  /** A positive integer lower or equal to 100 to select the number of items to return */
+  /**
+   * A positive integer lower or equal to 100 to select the number of items to
+   * return
+   */
   pageSize?: number
 }
 
@@ -160,11 +163,17 @@ export type ListOSRequest = {
   zone?: Zone
   /** A positive integer to choose the page to return */
   page?: number
-  /** A positive integer lower or equal to 100 to select the number of items to return */
+  /**
+   * A positive integer lower or equal to 100 to select the number of items to
+   * return
+   */
   pageSize?: number
   /** List of compatible server type */
   serverType?: string
-  /** Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12") */
+  /**
+   * Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not
+   * "12")
+   */
   name?: string
 }
 

packages/clients/src/api/baremetal/v1/api.gen.ts

@@ -289,7 +289,8 @@ export class BaremetalV1GenAPI extends API {
     )
 
   /**
-   * Reboot the server associated with the given ID, use boot param to reboot in rescue.
+   * Reboot the server associated with the given ID, use boot param to reboot in
+   * rescue.
    *
    * @param request - The request {@link RebootServerRequest}
    * @returns A Promise of Server
@@ -419,7 +420,8 @@ export class BaremetalV1GenAPI extends API {
     )
 
   /**
-   * Get the BMC (Baseboard Management Controller) access associated with the given ID.
+   * Get the BMC (Baseboard Management Controller) access associated with the
+   * given ID.
    *
    * @param request - The request {@link GetBMCAccessRequest}
    * @returns A Promise of BMCAccess
@@ -440,7 +442,8 @@ export class BaremetalV1GenAPI extends API {
     )
 
   /**
-   * Stop BMC (Baseboard Management Controller) access associated with the given ID.
+   * Stop BMC (Baseboard Management Controller) access associated with the given
+   * ID.
    *
    * @param request - The request {@link StopBMCAccessRequest}
    */

packages/clients/src/api/baremetal/v1/types.gen.ts

@@ -86,7 +86,10 @@ export interface BMCAccess {
    * authentification
    */
   password: string
-  /** The date after which the BMC (Baseboard Management Controller) access will be closed */
+  /**
+   * The date after which the BMC (Baseboard Management Controller) access will
+   * be closed
+   */
   expiresAt?: Date
 }
 
@@ -400,9 +403,15 @@ export interface ServerInstall {
   sshKeyIds: Array<string>
   /** Status of the server install */
   status: ServerInstallStatus
-  /** User defined in the server install or the default one if none were specified */
+  /**
+   * User defined in the server install or the default one if none were
+   * specified
+   */
   user: string
-  /** Service user defined in the server install or the default one if none were specified */
+  /**
+   * Service user defined in the server install or the default one if none were
+   * specified
+   */
   serviceUser: string
   /** The address of the installed service */
   serviceUrl: string
@@ -534,7 +543,10 @@ export type UpdateServerRequest = {
   serverId: string
   /** Name of the server (≠hostname), not updated if null */
   name?: string
-  /** Description associated to the server, max 255 characters, not updated if null */
+  /**
+   * Description associated to the server, max 255 characters, not updated if
+   * null
+   */
   description?: string
   /** Tags associated to the server, not updated if null */
   tags?: Array<string>

packages/clients/src/api/domain/v2beta1/api.gen.ts

@@ -189,7 +189,8 @@ export class DomainV2Beta1GenAPI extends API {
     )
 
   /**
-   * Returns a list of manageable DNS zones. You can filter the DNS zones by domain name.
+   * Returns a list of manageable DNS zones. You can filter the DNS zones by
+   * domain name.
    *
    * @param request - The request {@link ListDNSZonesRequest}
    * @returns A Promise of ListDNSZonesResponse
@@ -360,7 +361,8 @@ export class DomainV2Beta1GenAPI extends API {
     )
 
   /**
-   * Returns a list of Nameservers and their optional glue records for a DNS zone.
+   * Returns a list of Nameservers and their optional glue records for a DNS
+   * zone.
    *
    * @param request - The request {@link ListDNSZoneNameserversRequest}
    * @returns A Promise of ListDNSZoneNameserversResponse
@@ -869,7 +871,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
   /**
    * Request the registration of an external domain name.
    *
-   * @param request - The request {@link RegistrarApiRegisterExternalDomainRequest}
+   * @param request - The request
+   *   {@link RegistrarApiRegisterExternalDomainRequest}
    * @returns A Promise of RegisterExternalDomainResponse
    */
   registerExternalDomain = (
@@ -914,7 +917,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
    * Check if contacts are compatible against a domain or a tld. If not, it will
    * return the information requiring a correction.
    *
-   * @param request - The request {@link RegistrarApiCheckContactsCompatibilityRequest}
+   * @param request - The request
+   *   {@link RegistrarApiCheckContactsCompatibilityRequest}
    * @returns A Promise of CheckContactsCompatibilityResponse
    */
   checkContactsCompatibility = (
@@ -974,7 +978,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
     enrichForPagination('contacts', this.pageOfListContacts, request)
 
   /**
-   * Return a contact details retrieved from the registrar using a given contact ID.
+   * Return a contact details retrieved from the registrar using a given contact
+   * ID.
    *
    * @param request - The request {@link RegistrarApiGetContactRequest}
    * @returns A Promise of Contact
@@ -1116,7 +1121,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
 
   /**
    * 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.
+   * contact for multiple roles. Only one ID will be created and used for all of
+   * them.
    *
    * @param request - The request {@link RegistrarApiUpdateDomainRequest}
    * @returns A Promise of Domain
@@ -1186,7 +1192,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
   /**
    * Enable domain auto renew
    *
-   * @param request - The request {@link RegistrarApiEnableDomainAutoRenewRequest}
+   * @param request - The request
+   *   {@link RegistrarApiEnableDomainAutoRenewRequest}
    * @returns A Promise of Domain
    */
   enableDomainAutoRenew = (
@@ -1208,7 +1215,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
   /**
    * Disable domain auto renew
    *
-   * @param request - The request {@link RegistrarApiDisableDomainAutoRenewRequest}
+   * @param request - The request
+   *   {@link RegistrarApiDisableDomainAutoRenewRequest}
    * @returns A Promise of Domain
    */
   disableDomainAutoRenew = (
@@ -1230,7 +1238,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
   /**
    * 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.
+   * retrieve the auth code, in that case, the information is given in the
+   * message field.
    *
    * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest}
    * @returns A Promise of GetDomainAuthCodeResponse
@@ -1325,7 +1334,8 @@ export class DomainRegistrarV2Beta1GenAPI extends API {
    * If the TLD list is empty or not set the search returns the results from the
    * most popular TLDs.
    *
-   * @param request - The request {@link RegistrarApiSearchAvailableDomainsRequest}
+   * @param request - The request
+   *   {@link RegistrarApiSearchAvailableDomainsRequest}
    * @returns A Promise of SearchAvailableDomainsResponse
    */
   searchAvailableDomains = (

packages/clients/src/api/domain/v2beta1/types.gen.ts

@@ -384,12 +384,14 @@ export interface Domain {
   administrativeContact?: Contact
   /**
    * One-of ('registrationStatus'): at most one of
-   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set.
+   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be
+   * set.
    */
   externalDomainRegistrationStatus?: DomainRegistrationStatusExternalDomain
   /**
    * One-of ('registrationStatus'): at most one of
-   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set.
+   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be
+   * set.
    */
   transferRegistrationStatus?: DomainRegistrationStatusTransfer
 }
@@ -489,12 +491,14 @@ export interface DomainSummary {
   status: DomainStatus
   /**
    * One-of ('registrationStatus'): at most one of
-   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set.
+   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be
+   * set.
    */
   externalDomainRegistrationStatus?: DomainRegistrationStatusExternalDomain
   /**
    * One-of ('registrationStatus'): at most one of
-   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set.
+   * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be
+   * set.
    */
   transferRegistrationStatus?: DomainRegistrationStatusTransfer
   organizationId: string
@@ -666,13 +670,25 @@ export interface OrderResponse {
 }
 
 export interface RecordChange {
-  /** One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */
+  /**
+   * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be
+   * set.
+   */
   add?: RecordChangeAdd
-  /** One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */
+  /**
+   * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be
+   * set.
+   */
   set?: RecordChangeSet
-  /** One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */
+  /**
+   * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be
+   * set.
+   */
   delete?: RecordChangeDelete
-  /** One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */
+  /**
+   * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be
+   * set.
+   */
   clear?: RecordChangeClear
 }
 
@@ -875,9 +891,15 @@ export type UpdateDNSZoneRecordsRequest = {
   changes: Array<RecordChange>
   /** Whether or not to return all the records */
   returnAllRecords?: boolean
-  /** Forbid the creation of the target zone if not existing (default action is yes) */
+  /**
+   * Forbid the creation of the target zone if not existing (default action is
+   * yes)
+   */
   disallowNewZoneCreation: boolean
-  /** Don't use the autoincremenent serial but the provided one (0 to keep the same) */
+  /**
+   * Don't use the autoincremenent serial but the provided one (0 to keep the
+   * same)
+   */
   serial?: number
 }
 

packages/clients/src/api/function/v1beta1/types.gen.ts

@@ -136,9 +136,15 @@ export interface CreateTriggerInputRequestSqsClientConfigSpec {
 
 export interface CreateTriggerRequestNatsFailureHandlingPolicy {
   retryPolicy?: CreateTriggerRequestNatsFailureHandlingPolicyRetryPolicy
-  /** One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter' could be set. */
+  /**
+   * One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter'
+   * could be set.
+   */
   natsDeadLetter?: CreateTriggerRequestNatsFailureHandlingPolicyNatsDeadLetter
-  /** One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter' could be set. */
+  /**
+   * One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter'
+   * could be set.
+   */
   sqsDeadLetter?: CreateTriggerRequestNatsFailureHandlingPolicySqsDeadLetter
 }
 
@@ -389,9 +395,15 @@ export interface TriggerNatsDeadLetter {
 
 export interface TriggerNatsFailureHandlingPolicy {
   retryPolicy?: TriggerRetryPolicy
-  /** One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter' could be set. */
+  /**
+   * One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter'
+   * could be set.
+   */
   natsDeadLetter?: TriggerNatsDeadLetter
-  /** One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter' could be set. */
+  /**
+   * One-of ('deadLetter'): at most one of 'natsDeadLetter', 'sqsDeadLetter'
+   * could be set.
+   */
   sqsDeadLetter?: TriggerSqsDeadLetter
 }
 

packages/clients/src/api/iam/v1alpha1/types.gen.ts

@@ -309,13 +309,15 @@ export interface RuleSpecs {
   /**
    * List of project IDs scoped to the rule.
    *
-   * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be set.
+   * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be
+   * set.
    */
   projectIds?: Array<string>
   /**
    * ID of organization scoped to the rule.
    *
-   * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be set.
+   * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be
+   * set.
    */
   organizationId?: string
 }