docs(rdb): improve read replica documentation (#72)

Author: scaleway-bot

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

@@ -713,7 +713,7 @@ export class RdbV1GenAPI extends API {
     )
 
   /**
-   * Create a read replica
+   * You can only create a maximum of 3 read replicas for one instance.
    *
    * @param request - The request {@link CreateReadReplicaRequest}
    * @returns A Promise of ReadReplica
@@ -777,7 +777,9 @@ export class RdbV1GenAPI extends API {
     )
 
   /**
-   * Reset a read replica
+   * Resetting a read replica resyncs data from the leader node. This operation
+   * can take some time, depending on the database's size. During this
+   * operation, the read replica will not be available. Endpoints will not change.
    *
    * @param request - The request {@link ResetReadReplicaRequest}
    * @returns A Promise of ReadReplica
@@ -800,7 +802,7 @@ export class RdbV1GenAPI extends API {
     )
 
   /**
-   * Create a new endpoint for a given read replica
+   * A read replica can have at most one direct access and one private network endpoint.
    *
    * @param request - The request {@link CreateReadReplicaEndpointRequest}
    * @returns A Promise of ReadReplica

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

@@ -1301,7 +1301,7 @@ export type CreateEndpointRequest = {
 export type DeleteEndpointRequest = {
   /** Region to target. If none is passed will use default region from the config */
   region?: Region
-  /** UUID of the endpoint you want to delete */
+  /** This endpoint can also be used to delete a read replica endpoint. */
   endpointId: string
 }