Skip to content

Commit 13a1b15

Browse files
authored
docs(serverless): add note about mnq region availability (#996)
1 parent a4120dd commit 13a1b15

File tree

2 files changed

+42
-30
lines changed

2 files changed

+42
-30
lines changed

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

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,16 @@ export interface TriggerMnqNatsClientConfig {
107107
mnqNamespaceId?: string
108108
/** Name of the NATS subject the trigger listens to. */
109109
subject: string
110-
/** ID of the M&Q NATS account. */
110+
/** ID of the Messaging and Queuing NATS account. */
111111
mnqNatsAccountId: string
112-
/** ID of the M&Q project. */
112+
/** ID of the Messaging and Queuing project. */
113113
mnqProjectId: string
114-
/** Region of the M&Q project. */
114+
/** Currently, only the `fr-par` region is available. */
115115
mnqRegion: string
116-
/** ID of the M&Q credentials used to subscribe to the NATS subject. */
116+
/**
117+
* ID of the Messaging and Queuing credentials used to subscribe to the NATS
118+
* subject.
119+
*/
117120
mnqCredentialId?: string
118121
}
119122

@@ -122,11 +125,14 @@ export interface TriggerMnqSqsClientConfig {
122125
mnqNamespaceId?: string
123126
/** Name of the SQS queue the trigger listens to. */
124127
queue: string
125-
/** ID of the M&Q project. */
128+
/** ID of the Messaging and Queuing project. */
126129
mnqProjectId: string
127-
/** Region in which the M&Q project is activated. */
130+
/** Currently, only the `fr-par` region is available. */
128131
mnqRegion: string
129-
/** ID of the M&Q credentials used to read from the SQS queue. */
132+
/**
133+
* ID of the Messaging and Queuing credentials used to read from the SQS
134+
* queue.
135+
*/
130136
mnqCredentialId?: string
131137
}
132138

@@ -147,11 +153,11 @@ export interface CreateTriggerRequestMnqNatsClientConfig {
147153
mnqNamespaceId?: string
148154
/** Name of the NATS subject the trigger should listen to. */
149155
subject: string
150-
/** ID of the M&Q NATS account. */
156+
/** ID of the Messaging and Queuing NATS account. */
151157
mnqNatsAccountId: string
152-
/** ID of the M&Q project. */
158+
/** ID of the Messaging and Queuing project. */
153159
mnqProjectId: string
154-
/** Region of the M&Q project. */
160+
/** Currently, only the `fr-par` region is available. */
155161
mnqRegion: string
156162
}
157163

@@ -162,7 +168,7 @@ export interface CreateTriggerRequestMnqSqsClientConfig {
162168
queue: string
163169
/** You must have activated SQS on this project. */
164170
mnqProjectId: string
165-
/** Region in which the M&Q project is activated. */
171+
/** Currently, only the `fr-par` region is available. */
166172
mnqRegion: string
167173
}
168174

@@ -339,14 +345,14 @@ export interface Trigger {
339345
/** Error message of the trigger. */
340346
errorMessage?: string
341347
/**
342-
* Configuration for a Scaleway M&Q SQS queue.
348+
* Configuration for a Scaleway Messaging and Queuing SQS queue.
343349
*
344350
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
345351
* 'sqsConfig' could be set.
346352
*/
347353
scwSqsConfig?: TriggerMnqSqsClientConfig
348354
/**
349-
* Configuration for a Scaleway M&Q NATS subject.
355+
* Configuration for a Scaleway Messaging and Queuing NATS subject.
350356
*
351357
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
352358
* 'sqsConfig' could be set.
@@ -498,14 +504,14 @@ export type CreateTriggerRequest = {
498504
/** Description of the trigger. */
499505
description?: string
500506
/**
501-
* Configuration for a Scaleway M&Q SQS queue.
507+
* Configuration for a Scaleway Messaging and Queuing SQS queue.
502508
*
503509
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
504510
* 'sqsConfig' could be set.
505511
*/
506512
scwSqsConfig?: CreateTriggerRequestMnqSqsClientConfig
507513
/**
508-
* Configuration for a Scaleway M&Q NATS subject.
514+
* Configuration for a Scaleway Messaging and Queuing NATS subject.
509515
*
510516
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
511517
* 'sqsConfig' could be set.

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

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -140,13 +140,16 @@ export interface TriggerMnqNatsClientConfig {
140140
mnqNamespaceId?: string
141141
/** Name of the NATS subject the trigger listens to. */
142142
subject: string
143-
/** ID of the M&Q NATS account. */
143+
/** ID of the Messaging and Queuing NATS account. */
144144
mnqNatsAccountId: string
145-
/** ID of the M&Q project. */
145+
/** ID of the Messaging and Queuing project. */
146146
mnqProjectId: string
147-
/** Region of the M&Q project. */
147+
/** Currently, only the `fr-par` region is available. */
148148
mnqRegion: string
149-
/** ID of the M&Q credentials used to subscribe to the NATS subject. */
149+
/**
150+
* ID of the Messaging and Queuing credentials used to subscribe to the NATS
151+
* subject.
152+
*/
150153
mnqCredentialId?: string
151154
}
152155

@@ -155,11 +158,14 @@ export interface TriggerMnqSqsClientConfig {
155158
mnqNamespaceId?: string
156159
/** Name of the SQS queue the trigger listens to. */
157160
queue: string
158-
/** ID of the M&Q project. */
161+
/** ID of the Messaging and Queuing project. */
159162
mnqProjectId: string
160-
/** Region in which the M&Q project is activated. */
163+
/** Currently, only the `fr-par` region is available. */
161164
mnqRegion: string
162-
/** ID of the M&Q credentials used to read from the SQS queue. */
165+
/**
166+
* ID of the Messaging and Queuing credentials used to read from the SQS
167+
* queue.
168+
*/
163169
mnqCredentialId?: string
164170
}
165171

@@ -180,11 +186,11 @@ export interface CreateTriggerRequestMnqNatsClientConfig {
180186
mnqNamespaceId?: string
181187
/** Name of the NATS subject the trigger should listen to. */
182188
subject: string
183-
/** ID of the M&Q NATS account. */
189+
/** ID of the Messaging and Queuing NATS account. */
184190
mnqNatsAccountId: string
185-
/** ID of the M&Q project. */
191+
/** ID of the Messaging and Queuing project. */
186192
mnqProjectId: string
187-
/** Region of the M&Q project. */
193+
/** Currently, only the `fr-par` region is available. */
188194
mnqRegion: string
189195
}
190196

@@ -195,7 +201,7 @@ export interface CreateTriggerRequestMnqSqsClientConfig {
195201
queue: string
196202
/** You must have activated SQS on this project. */
197203
mnqProjectId: string
198-
/** Region in which the M&Q project is activated. */
204+
/** Currently, only the `fr-par` region is available. */
199205
mnqRegion: string
200206
}
201207

@@ -384,14 +390,14 @@ export interface Trigger {
384390
/** Error message of the trigger. */
385391
errorMessage?: string
386392
/**
387-
* Configuration for a Scaleway M&Q SQS queue.
393+
* Configuration for a Scaleway Messaging and Queuing SQS queue.
388394
*
389395
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
390396
* 'sqsConfig' could be set.
391397
*/
392398
scwSqsConfig?: TriggerMnqSqsClientConfig
393399
/**
394-
* Configuration for a Scaleway M&Q NATS subject.
400+
* Configuration for a Scaleway Messaging and Queuing NATS subject.
395401
*
396402
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
397403
* 'sqsConfig' could be set.
@@ -532,14 +538,14 @@ export type CreateTriggerRequest = {
532538
/** Description of the trigger. */
533539
description?: string
534540
/**
535-
* Configuration for a Scaleway M&Q SQS queue.
541+
* Configuration for a Scaleway Messaging and Queuing SQS queue.
536542
*
537543
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
538544
* 'sqsConfig' could be set.
539545
*/
540546
scwSqsConfig?: CreateTriggerRequestMnqSqsClientConfig
541547
/**
542-
* Configuration for a Scaleway M&Q NATS subject.
548+
* Configuration for a Scaleway Messaging and Queuing NATS subject.
543549
*
544550
* One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig',
545551
* 'sqsConfig' could be set.

0 commit comments

Comments
 (0)