Skip to content

docs(rdb): add more specific info about endpoint types in api doc #304

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2022
Merged

docs(rdb): add more specific info about endpoint types in api doc #304

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
28 changes: 20 additions & 8 deletions packages/clients/src/api/rdb/v1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,21 +231,25 @@ export interface Endpoint {
/** Name of the endpoint */
name?: string
/**
* Private network details.
* Private network details. One at the most per RDB instance or read replica
* (an RDB instance and its read replica can have different private networks).
* Cannot be updated (has to be deleted and recreated).
*
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer',
* 'directAccess' could be set.
*/
privateNetwork?: EndpointPrivateNetworkDetails
/**
* Load balancer details.
* Load balancer details. Public endpoint for RDB instances which is
* systematically present. One per RDB instance.
*
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer',
* 'directAccess' could be set.
*/
loadBalancer?: EndpointLoadBalancerDetails
/**
* Direct access details.
* Direct access details. Public endpoint reserved for read replicas. One per
* read replica.
*
* One-of ('details'): at most one of 'privateNetwork', 'loadBalancer',
* 'directAccess' could be set.
Expand Down Expand Up @@ -276,14 +280,17 @@ export interface EndpointPrivateNetworkDetails {
/** Endpoint spec */
export interface EndpointSpec {
/**
* Load balancer endpoint specifications.
* Load balancer endpoint specifications. Public endpoint for RDB instances
* which is systematically present. One per RDB instance.
*
* One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be
* set.
*/
loadBalancer?: EndpointSpecLoadBalancer
/**
* Private network endpoint specifications.
* Private network endpoint specifications. One at the most per RDB instance
* or read replica (an RDB instance and its read replica can have different
* private networks). Cannot be updated (has to be deleted and recreated).
*
* One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be
* set.
Expand Down Expand Up @@ -617,14 +624,16 @@ export interface ReadReplica {
/** Read replica endpoint spec */
export interface ReadReplicaEndpointSpec {
/**
* Direct access endpoint specifications.
* Direct access endpoint specifications. Public endpoint reserved for read
* replicas. One per read replica.
*
* One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be
* set.
*/
directAccess?: ReadReplicaEndpointSpecDirectAccess
/**
* Private network endpoint specifications.
* Private network endpoint specifications. One at the most per read replica.
* Cannot be updated (has to be deleted and recreated).
*
* One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be
* set.
Expand Down Expand Up @@ -913,7 +922,10 @@ export type CreateInstanceRequest = {
volumeType: VolumeType
/** Volume size when volume_type is not lssd */
volumeSize: number
/** One or multiple EndpointSpec used to expose your database instance */
/**
* One or multiple EndpointSpec used to expose your database instance. A
* load_balancer public endpoint is systematically created
*/
initEndpoints?: Array<EndpointSpec>
/** Store logical backups in the same region as the database instance */
backupSameRegion: boolean
Expand Down