Skip to content

docs(mongodb): add documentation #1531

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
Oct 25, 2024
Merged

docs(mongodb): add documentation #1531

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
33 changes: 16 additions & 17 deletions packages/clients/src/api/mongodb/v1alpha1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ const jsonContentHeaders = {
}

/**
* Managed Database for MongoDB.
* Managed Database for MongoDB®.
*
* This API allows you to manage your Managed Databases for MongoDB.
* This API allows you to manage your Managed Databases for MongoDB®.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down Expand Up @@ -118,7 +118,7 @@ export class API extends ParentAPI {
)

/**
* List available MongoDB™ versions.
* List available MongoDB® versions.
*
* @param request - The request {@link ListVersionsRequest}
* @returns A Promise of ListVersionsResponse
Expand Down Expand Up @@ -157,14 +157,13 @@ export class API extends ParentAPI {
)

/**
* List MongoDB™ Database Instances. List all MongoDB™ Database Instances in
* the specified region, for a given Scaleway Project. By default, the
* MongoDB™ Database Instances returned in the list are ordered by creation
* date in ascending order, though this can be modified via the order_by
* field. You can define additional parameters for your query, such as `tags`
* and `name`. For the `name` parameter, the value you include will be checked
* against the whole name string to see if it includes the string you put in
* the parameter.
* List MongoDB® Database Instances. List all MongoDB® Database Instances in
* the specified region. By default, the MongoDB® Database Instances returned
* in the list are ordered by creation date in ascending order, though this
* can be modified via the order_by field. You can define additional
* parameters for your query, such as `tags` and `name`. For the `name`
* parameter, the value you include will be checked against the whole name
* string to see if it includes the string you put in the parameter.
*
* @param request - The request {@link ListInstancesRequest}
* @returns A Promise of ListInstancesResponse
Expand All @@ -173,8 +172,8 @@ export class API extends ParentAPI {
enrichForPagination('instances', this.pageOfListInstances, request)

/**
* Get a MongoDB™ Database Instance. Retrieve information about a given
* MongoDB™ Database Instance, specified by the `region` and `instance_id`
* Get a MongoDB® Database Instance. Retrieve information about a given
* MongoDB® Database Instance, specified by the `region` and `instance_id`
* parameters. Its full details, including name, status, IP address and port,
* are returned in the response object.
*
Expand Down Expand Up @@ -211,7 +210,7 @@ export class API extends ParentAPI {
)

/**
* Create a MongoDB™ Database Instance. Create a new MongoDB™ Database
* Create a MongoDB® Database Instance. Create a new MongoDB® Database
* Instance.
*
* @param request - The request {@link CreateInstanceRequest}
Expand All @@ -231,7 +230,7 @@ export class API extends ParentAPI {
)

/**
* Update a MongoDB™ Database Instance. Update the parameters of a MongoDB™
* Update a MongoDB® Database Instance. Update the parameters of a MongoDB®
* Database Instance.
*
* @param request - The request {@link UpdateInstanceRequest}
Expand All @@ -251,9 +250,9 @@ export class API extends ParentAPI {
)

/**
* Delete a MongoDB™ Database Instance. Delete a given MongoDB™ Database
* Delete a MongoDB® Database Instance. Delete a given MongoDB® Database
* Instance, specified by the `region` and `instance_id` parameters. Deleting
* a MongoDB™ Database Instance is permanent, and cannot be undone. Note that
* a MongoDB® Database Instance is permanent, and cannot be undone. Note that
* upon deletion all your data will be lost.
*
* @param request - The request {@link DeleteInstanceRequest}
Expand Down
50 changes: 25 additions & 25 deletions packages/clients/src/api/mongodb/v1alpha1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,14 @@ export type VolumeType = 'unknown_type' | 'sbs_5k' | 'sbs_15k'

/** Private Network details. */
export interface EndpointPrivateNetworkDetails {
/** UUID of the private network. */
/** UUID of the Private Network. */
privateNetworkId: string
}

export interface EndpointPublicDetails {}

export interface EndpointSpecPrivateNetworkDetails {
/** UUID of the private network. */
/** UUID of the Private Network. */
privateNetworkId: string
}

Expand Down Expand Up @@ -105,11 +105,11 @@ export interface Volume {
export interface NodeTypeVolumeType {
/** Volume Type. */
type: VolumeType
/** The description of the Volume. */
/** The description of the volume. */
description: string
/** Mimimum size required for the Volume. */
/** Mimimum size required for the volume. */
minSize: number
/** Maximum size required for the Volume. */
/** Maximum size required for the volume. */
maxSize: number
/** Minimum increment level for a Block Storage volume size. */
chunkSize: number
Expand Down Expand Up @@ -167,7 +167,7 @@ export interface Instance {
projectId: string
/** Status of the Database Instance. */
status: InstanceStatus
/** MongoDB™ engine version of the Database Instance. */
/** MongoDB® engine version of the Database Instance. */
version: string
/** List of tags applied to the Database Instance. */
tags: string[]
Expand All @@ -188,23 +188,23 @@ export interface Instance {
}

export interface NodeType {
/** Node Type name identifier. */
/** Node type name identifier. */
name: string
/** Current stock status for the Node Type. */
/** Current stock status for the node type. */
stockStatus: NodeTypeStock
/** Current specs of the offer. */
description: string
/** Number of virtual CPUs. */
vcpus: number
/** Quantity of RAM. */
memory: number
/** Available storage options for the Node Type. */
/** Available storage options for the node type. */
availableVolumeTypes: NodeTypeVolumeType[]
/** The Node Type is currently disabled. */
/** The node type is currently disabled. */
disabled: boolean
/** The Node Type is currently in beta. */
/** The node type is currently in beta. */
beta: boolean
/** Instance range associated with the NodeType offer. */
/** Instance range associated with the node type offer. */
instanceRange: string
}

Expand All @@ -229,9 +229,9 @@ export interface Snapshot {
instanceName: string
/** Source node type. */
nodeType: string
/** Type of volume where data is stored sbs_5k or sbs_15k. */
/** Type of volume where data is stored - sbs_5k or sbs_15k. */
volumeType?: SnapshotVolumeType
/** Region of this snapshot. */
/** Region of the snapshot. */
region: Region
}

Expand All @@ -245,7 +245,7 @@ export interface User {
}

export interface Version {
/** MongoDB™ engine version. */
/** MongoDB® engine version. */
version: string
/** Date of End of Life. */
endOfLifeAt?: Date
Expand All @@ -268,7 +268,7 @@ export type CreateInstanceRequest = {
projectId?: string
/** Name of the Database Instance. */
name?: string
/** Version of the MongoDB™ engine. */
/** Version of the MongoDB® engine. */
version: string
/** Tags to apply to the Database Instance. */
tags?: string[]
Expand Down Expand Up @@ -362,9 +362,9 @@ export type ListInstancesRequest = {
name?: string
/** Criteria to use when ordering Database Instance listings. */
orderBy?: ListInstancesRequestOrderBy
/** Organization ID the Database Instance belongs to. */
/** Organization ID of the Database Instance. */
organizationId?: string
/** Project ID to list the Database Instance of. */
/** Project ID. */
projectId?: string
page?: number
pageSize?: number
Expand All @@ -373,7 +373,7 @@ export type ListInstancesRequest = {
export interface ListInstancesResponse {
/** List of all Database Instances available in an Organization or Project. */
instances: Instance[]
/** Total count of Database Instances available in a Organization or Project. */
/** Total count of Database Instances available in an Organization or Project. */
totalCount: number
}

Expand Down Expand Up @@ -404,7 +404,7 @@ export type ListSnapshotsRequest = {
region?: Region
/** Instance ID the snapshots belongs to. */
instanceId?: string
/** Lists Database snapshots that match a name pattern. */
/** Lists database snapshots that match a name pattern. */
name?: string
/** Criteria to use when ordering snapshot listings. */
orderBy?: ListSnapshotsRequestOrderBy
Expand All @@ -417,9 +417,9 @@ export type ListSnapshotsRequest = {
}

export interface ListSnapshotsResponse {
/** List of all Database Snapshots available in an Organization or Project. */
/** List of all database snapshots available in an Organization or Project. */
snapshots: Snapshot[]
/** Total count of Database Snapshots available in a Organization or Project. */
/** Total count of database snapshots available in a Organization or Project. */
totalCount: number
}

Expand Down Expand Up @@ -458,9 +458,9 @@ export type ListVersionsRequest = {
}

export interface ListVersionsResponse {
/** Available MongoDB™ engine version. */
/** Available MongoDB® engine version. */
versions: Version[]
/** Total count of MongoDB™ engine version available. */
/** Total count of MongoDB® engine version available. */
totalCount: number
}

Expand Down Expand Up @@ -533,7 +533,7 @@ export type UpgradeInstanceRequest = {
/** UUID of the Database Instance you want to upgrade. */
instanceId: string
/**
* Increase your block storage volume size.
* Increase your Block Storage volume size.
*
* One-of ('upgradeTarget'): at most one of 'volumeSize' could be set.
*/
Expand Down