Skip to content

Commit fc15bac

Browse files
authored
docs(mnq): follow the renaming of the product on the current API (scaleway#2345)
1 parent 1e60263 commit fc15bac

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

api/mnq/v1beta1/mnq_sdk.go

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -338,25 +338,25 @@ type File struct {
338338

339339
// SnsPermissions: sns permissions.
340340
type SnsPermissions struct {
341-
// CanPublish: defines whether the credentials bearer can publish messages to the service (publish to SNS topics).
341+
// CanPublish: defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics).
342342
CanPublish *bool `json:"can_publish"`
343343

344344
// CanReceive: defines whether the credentials bearer can receive messages from the service (configure subscriptions).
345345
CanReceive *bool `json:"can_receive"`
346346

347-
// CanManage: defines whether the credentials bearer can manage the associated SNS topics or subscriptions.
347+
// CanManage: defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions.
348348
CanManage *bool `json:"can_manage"`
349349
}
350350

351351
// SqsPermissions: sqs permissions.
352352
type SqsPermissions struct {
353-
// CanPublish: defines whether the credentials bearer can publish messages to the service (send messages to SQS queues).
353+
// CanPublish: defines whether the credentials bearer can publish messages to the service (send messages to Queues queues).
354354
CanPublish *bool `json:"can_publish"`
355355

356-
// CanReceive: defines whether the credentials bearer can receive messages from SQS queues.
356+
// CanReceive: defines whether the credentials bearer can receive messages from Queues queues.
357357
CanReceive *bool `json:"can_receive"`
358358

359-
// CanManage: defines whether the credentials bearer can manage the associated SQS queues.
359+
// CanManage: defines whether the credentials bearer can manage the associated Queues queues.
360360
CanManage *bool `json:"can_manage"`
361361
}
362362

@@ -431,7 +431,7 @@ type SnsCredentials struct {
431431
// AccessKey: access key ID.
432432
AccessKey string `json:"access_key"`
433433

434-
// SecretKey: secret key ID (Only returned by **Create SNS Credentials** call).
434+
// SecretKey: secret key ID (Only returned by **Create Topics and Events Credentials** call).
435435
SecretKey string `json:"secret_key"`
436436

437437
// SecretChecksum: checksum of the Secret key.
@@ -464,7 +464,7 @@ type SqsCredentials struct {
464464
// AccessKey: access key ID.
465465
AccessKey string `json:"access_key"`
466466

467-
// SecretKey: secret key ID (Only returned by **Create SQS Credentials** call).
467+
// SecretKey: secret key ID (Only returned by **Create Queues Credentials** call).
468468
SecretKey string `json:"secret_key"`
469469

470470
// SecretChecksum: checksum of the Secret key.
@@ -535,7 +535,7 @@ type ListSnsCredentialsResponse struct {
535535
// TotalCount: total count of existing credentials (matching any filters specified).
536536
TotalCount uint64 `json:"total_count"`
537537

538-
// SnsCredentials: sNS credentials on this page.
538+
// SnsCredentials: topics and Events credentials on this page.
539539
SnsCredentials []*SnsCredentials `json:"sns_credentials"`
540540
}
541541

@@ -563,7 +563,7 @@ type ListSqsCredentialsResponse struct {
563563
// TotalCount: total count of existing credentials (matching any filters specified).
564564
TotalCount uint64 `json:"total_count"`
565565

566-
// SqsCredentials: sQS credentials on this page.
566+
// SqsCredentials: queues credentials on this page.
567567
SqsCredentials []*SqsCredentials `json:"sqs_credentials"`
568568
}
569569

@@ -704,7 +704,7 @@ type SnsAPIActivateSnsRequest struct {
704704
// Region: region to target. If none is passed will use default region from the config.
705705
Region scw.Region `json:"-"`
706706

707-
// ProjectID: project on which to activate the SNS service.
707+
// ProjectID: project on which to activate the Topics and Events service.
708708
ProjectID string `json:"project_id"`
709709
}
710710

@@ -713,7 +713,7 @@ type SnsAPICreateSnsCredentialsRequest struct {
713713
// Region: region to target. If none is passed will use default region from the config.
714714
Region scw.Region `json:"-"`
715715

716-
// ProjectID: project containing the SNS credentials.
716+
// ProjectID: project containing the Topics and Events credentials.
717717
ProjectID string `json:"project_id"`
718718

719719
// Name: name of the credentials.
@@ -728,7 +728,7 @@ type SnsAPIDeactivateSnsRequest struct {
728728
// Region: region to target. If none is passed will use default region from the config.
729729
Region scw.Region `json:"-"`
730730

731-
// ProjectID: project on which to deactivate the SNS service.
731+
// ProjectID: project on which to deactivate the Topics and Events service.
732732
ProjectID string `json:"project_id"`
733733
}
734734

@@ -746,7 +746,7 @@ type SnsAPIGetSnsCredentialsRequest struct {
746746
// Region: region to target. If none is passed will use default region from the config.
747747
Region scw.Region `json:"-"`
748748

749-
// SnsCredentialsID: ID of the SNS credentials to get.
749+
// SnsCredentialsID: ID of the Topics and Events credentials to get.
750750
SnsCredentialsID string `json:"-"`
751751
}
752752

@@ -755,7 +755,7 @@ type SnsAPIGetSnsInfoRequest struct {
755755
// Region: region to target. If none is passed will use default region from the config.
756756
Region scw.Region `json:"-"`
757757

758-
// ProjectID: project to retrieve SNS info from.
758+
// ProjectID: project to retrieve Topics and Events info from.
759759
ProjectID string `json:"project_id"`
760760
}
761761

@@ -764,7 +764,7 @@ type SnsAPIListSnsCredentialsRequest struct {
764764
// Region: region to target. If none is passed will use default region from the config.
765765
Region scw.Region `json:"-"`
766766

767-
// ProjectID: include only SNS credentials in this Project.
767+
// ProjectID: include only Topics and Events credentials in this Project.
768768
ProjectID *string `json:"-"`
769769

770770
// Page: page number to return.
@@ -783,7 +783,7 @@ type SnsAPIUpdateSnsCredentialsRequest struct {
783783
// Region: region to target. If none is passed will use default region from the config.
784784
Region scw.Region `json:"-"`
785785

786-
// SnsCredentialsID: ID of the SNS credentials to update.
786+
// SnsCredentialsID: ID of the Topics and Events credentials to update.
787787
SnsCredentialsID string `json:"-"`
788788

789789
// Name: name of the credentials.
@@ -801,17 +801,17 @@ type SnsInfo struct {
801801
// Region: region of the service.
802802
Region scw.Region `json:"region"`
803803

804-
// CreatedAt: sNS creation date.
804+
// CreatedAt: topics and Events creation date.
805805
CreatedAt *time.Time `json:"created_at"`
806806

807-
// UpdatedAt: sNS last modification date.
807+
// UpdatedAt: topics and Events last modification date.
808808
UpdatedAt *time.Time `json:"updated_at"`
809809

810-
// Status: sNS activation status.
810+
// Status: topics and Events activation status.
811811
// Default value: unknown_status
812812
Status SnsInfoStatus `json:"status"`
813813

814-
// SnsEndpointURL: endpoint of the SNS service for this region and project.
814+
// SnsEndpointURL: endpoint of the Topics and Events service for this region and project.
815815
SnsEndpointURL string `json:"sns_endpoint_url"`
816816
}
817817

@@ -820,7 +820,7 @@ type SqsAPIActivateSqsRequest struct {
820820
// Region: region to target. If none is passed will use default region from the config.
821821
Region scw.Region `json:"-"`
822822

823-
// ProjectID: project on which to activate the SQS service.
823+
// ProjectID: project on which to activate the Queues service.
824824
ProjectID string `json:"project_id"`
825825
}
826826

@@ -829,7 +829,7 @@ type SqsAPICreateSqsCredentialsRequest struct {
829829
// Region: region to target. If none is passed will use default region from the config.
830830
Region scw.Region `json:"-"`
831831

832-
// ProjectID: project containing the SQS credentials.
832+
// ProjectID: project containing the Queues credentials.
833833
ProjectID string `json:"project_id"`
834834

835835
// Name: name of the credentials.
@@ -844,7 +844,7 @@ type SqsAPIDeactivateSqsRequest struct {
844844
// Region: region to target. If none is passed will use default region from the config.
845845
Region scw.Region `json:"-"`
846846

847-
// ProjectID: project on which to deactivate the SQS service.
847+
// ProjectID: project on which to deactivate the Queues service.
848848
ProjectID string `json:"project_id"`
849849
}
850850

@@ -862,7 +862,7 @@ type SqsAPIGetSqsCredentialsRequest struct {
862862
// Region: region to target. If none is passed will use default region from the config.
863863
Region scw.Region `json:"-"`
864864

865-
// SqsCredentialsID: ID of the SQS credentials to get.
865+
// SqsCredentialsID: ID of the Queues credentials to get.
866866
SqsCredentialsID string `json:"-"`
867867
}
868868

@@ -871,7 +871,7 @@ type SqsAPIGetSqsInfoRequest struct {
871871
// Region: region to target. If none is passed will use default region from the config.
872872
Region scw.Region `json:"-"`
873873

874-
// ProjectID: project to retrieve SQS info from.
874+
// ProjectID: project to retrieve Queues info from.
875875
ProjectID string `json:"project_id"`
876876
}
877877

@@ -880,7 +880,7 @@ type SqsAPIListSqsCredentialsRequest struct {
880880
// Region: region to target. If none is passed will use default region from the config.
881881
Region scw.Region `json:"-"`
882882

883-
// ProjectID: include only SQS credentials in this Project.
883+
// ProjectID: include only Queues credentials in this Project.
884884
ProjectID *string `json:"-"`
885885

886886
// Page: page number to return.
@@ -899,7 +899,7 @@ type SqsAPIUpdateSqsCredentialsRequest struct {
899899
// Region: region to target. If none is passed will use default region from the config.
900900
Region scw.Region `json:"-"`
901901

902-
// SqsCredentialsID: ID of the SQS credentials to update.
902+
// SqsCredentialsID: ID of the Queues credentials to update.
903903
SqsCredentialsID string `json:"-"`
904904

905905
// Name: name of the credentials.
@@ -917,21 +917,21 @@ type SqsInfo struct {
917917
// Region: region of the service.
918918
Region scw.Region `json:"region"`
919919

920-
// CreatedAt: sQS creation date.
920+
// CreatedAt: queues creation date.
921921
CreatedAt *time.Time `json:"created_at"`
922922

923-
// UpdatedAt: sQS last modification date.
923+
// UpdatedAt: queues last modification date.
924924
UpdatedAt *time.Time `json:"updated_at"`
925925

926-
// Status: sQS activation status.
926+
// Status: queues activation status.
927927
// Default value: unknown_status
928928
Status SqsInfoStatus `json:"status"`
929929

930-
// SqsEndpointURL: endpoint of the SQS service for this region and project.
930+
// SqsEndpointURL: endpoint of the Queues service for this region and project.
931931
SqsEndpointURL string `json:"sqs_endpoint_url"`
932932
}
933933

934-
// This API allows you to manage Scaleway Messaging and Queuing NATS accounts.
934+
// This API allows you to manage Scaleway NATS accounts.
935935
type NatsAPI struct {
936936
client *scw.Client
937937
}
@@ -1258,7 +1258,7 @@ func (s *NatsAPI) ListNatsCredentials(req *NatsAPIListNatsCredentialsRequest, op
12581258
return &resp, nil
12591259
}
12601260

1261-
// This API allows you to manage your Scaleway Messaging and Queuing SNS brokers.
1261+
// This API allows you to manage your Scaleway Topics and Events.
12621262
type SnsAPI struct {
12631263
client *scw.Client
12641264
}
@@ -1273,7 +1273,7 @@ func (s *SnsAPI) Regions() []scw.Region {
12731273
return []scw.Region{scw.RegionFrPar, scw.RegionNlAms}
12741274
}
12751275

1276-
// ActivateSns: Activate SNS for the specified Project ID. SNS must be activated before any usage. Activating SNS does not trigger any billing, and you can deactivate at any time.
1276+
// ActivateSns: Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time.
12771277
func (s *SnsAPI) ActivateSns(req *SnsAPIActivateSnsRequest, opts ...scw.RequestOption) (*SnsInfo, error) {
12781278
var err error
12791279

@@ -1310,7 +1310,7 @@ func (s *SnsAPI) ActivateSns(req *SnsAPIActivateSnsRequest, opts ...scw.RequestO
13101310
return &resp, nil
13111311
}
13121312

1313-
// GetSnsInfo: Retrieve the SNS information of the specified Project ID. Informations include the activation status and the SNS API endpoint URL.
1313+
// GetSnsInfo: Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.
13141314
func (s *SnsAPI) GetSnsInfo(req *SnsAPIGetSnsInfoRequest, opts ...scw.RequestOption) (*SnsInfo, error) {
13151315
var err error
13161316

@@ -1346,7 +1346,7 @@ func (s *SnsAPI) GetSnsInfo(req *SnsAPIGetSnsInfoRequest, opts ...scw.RequestOpt
13461346
return &resp, nil
13471347
}
13481348

1349-
// DeactivateSns: Deactivate SNS for the specified Project ID.You must delete all topics and credentials before this call or you need to set the force_delete parameter.
1349+
// DeactivateSns: Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter.
13501350
func (s *SnsAPI) DeactivateSns(req *SnsAPIDeactivateSnsRequest, opts ...scw.RequestOption) (*SnsInfo, error) {
13511351
var err error
13521352

@@ -1383,7 +1383,7 @@ func (s *SnsAPI) DeactivateSns(req *SnsAPIDeactivateSnsRequest, opts ...scw.Requ
13831383
return &resp, nil
13841384
}
13851385

1386-
// CreateSnsCredentials: Create a set of credentials for SNS, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.
1386+
// CreateSnsCredentials: Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.
13871387
func (s *SnsAPI) CreateSnsCredentials(req *SnsAPICreateSnsCredentialsRequest, opts ...scw.RequestOption) (*SnsCredentials, error) {
13881388
var err error
13891389

@@ -1424,7 +1424,7 @@ func (s *SnsAPI) CreateSnsCredentials(req *SnsAPICreateSnsCredentialsRequest, op
14241424
return &resp, nil
14251425
}
14261426

1427-
// DeleteSnsCredentials: Delete a set of SNS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SNS.
1427+
// DeleteSnsCredentials: Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events.
14281428
func (s *SnsAPI) DeleteSnsCredentials(req *SnsAPIDeleteSnsCredentialsRequest, opts ...scw.RequestOption) error {
14291429
var err error
14301430

@@ -1453,7 +1453,7 @@ func (s *SnsAPI) DeleteSnsCredentials(req *SnsAPIDeleteSnsCredentialsRequest, op
14531453
return nil
14541454
}
14551455

1456-
// UpdateSnsCredentials: Update a set of SNS credentials. You can update the credentials' name, or their permissions.
1456+
// UpdateSnsCredentials: Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions.
14571457
func (s *SnsAPI) UpdateSnsCredentials(req *SnsAPIUpdateSnsCredentialsRequest, opts ...scw.RequestOption) (*SnsCredentials, error) {
14581458
var err error
14591459

@@ -1520,7 +1520,7 @@ func (s *SnsAPI) GetSnsCredentials(req *SnsAPIGetSnsCredentialsRequest, opts ...
15201520
return &resp, nil
15211521
}
15221522

1523-
// ListSnsCredentials: List existing SNS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
1523+
// ListSnsCredentials: List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
15241524
func (s *SnsAPI) ListSnsCredentials(req *SnsAPIListSnsCredentialsRequest, opts ...scw.RequestOption) (*ListSnsCredentialsResponse, error) {
15251525
var err error
15261526

@@ -1559,7 +1559,7 @@ func (s *SnsAPI) ListSnsCredentials(req *SnsAPIListSnsCredentialsRequest, opts .
15591559
return &resp, nil
15601560
}
15611561

1562-
// This API allows you to manage your Scaleway Messaging and Queuing SQS brokers.
1562+
// This API allows you to manage your Scaleway Queues.
15631563
type SqsAPI struct {
15641564
client *scw.Client
15651565
}
@@ -1574,7 +1574,7 @@ func (s *SqsAPI) Regions() []scw.Region {
15741574
return []scw.Region{scw.RegionFrPar, scw.RegionNlAms}
15751575
}
15761576

1577-
// ActivateSqs: Activate SQS for the specified Project ID. SQS must be activated before any usage such as creating credentials and queues. Activating SQS does not trigger any billing, and you can deactivate at any time.
1577+
// ActivateSqs: Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time.
15781578
func (s *SqsAPI) ActivateSqs(req *SqsAPIActivateSqsRequest, opts ...scw.RequestOption) (*SqsInfo, error) {
15791579
var err error
15801580

@@ -1611,7 +1611,7 @@ func (s *SqsAPI) ActivateSqs(req *SqsAPIActivateSqsRequest, opts ...scw.RequestO
16111611
return &resp, nil
16121612
}
16131613

1614-
// GetSqsInfo: Retrieve the SQS information of the specified Project ID. Informations include the activation status and the SQS API endpoint URL.
1614+
// GetSqsInfo: Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL.
16151615
func (s *SqsAPI) GetSqsInfo(req *SqsAPIGetSqsInfoRequest, opts ...scw.RequestOption) (*SqsInfo, error) {
16161616
var err error
16171617

@@ -1647,7 +1647,7 @@ func (s *SqsAPI) GetSqsInfo(req *SqsAPIGetSqsInfoRequest, opts ...scw.RequestOpt
16471647
return &resp, nil
16481648
}
16491649

1650-
// DeactivateSqs: Deactivate SQS for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.
1650+
// DeactivateSqs: Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.
16511651
func (s *SqsAPI) DeactivateSqs(req *SqsAPIDeactivateSqsRequest, opts ...scw.RequestOption) (*SqsInfo, error) {
16521652
var err error
16531653

@@ -1684,7 +1684,7 @@ func (s *SqsAPI) DeactivateSqs(req *SqsAPIDeactivateSqsRequest, opts ...scw.Requ
16841684
return &resp, nil
16851685
}
16861686

1687-
// CreateSqsCredentials: Create a set of credentials for SQS, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.
1687+
// CreateSqsCredentials: Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.
16881688
func (s *SqsAPI) CreateSqsCredentials(req *SqsAPICreateSqsCredentialsRequest, opts ...scw.RequestOption) (*SqsCredentials, error) {
16891689
var err error
16901690

@@ -1725,7 +1725,7 @@ func (s *SqsAPI) CreateSqsCredentials(req *SqsAPICreateSqsCredentialsRequest, op
17251725
return &resp, nil
17261726
}
17271727

1728-
// DeleteSqsCredentials: Delete a set of SQS credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access SQS.
1728+
// DeleteSqsCredentials: Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues.
17291729
func (s *SqsAPI) DeleteSqsCredentials(req *SqsAPIDeleteSqsCredentialsRequest, opts ...scw.RequestOption) error {
17301730
var err error
17311731

@@ -1754,7 +1754,7 @@ func (s *SqsAPI) DeleteSqsCredentials(req *SqsAPIDeleteSqsCredentialsRequest, op
17541754
return nil
17551755
}
17561756

1757-
// UpdateSqsCredentials: Update a set of SQS credentials. You can update the credentials' name, or their permissions.
1757+
// UpdateSqsCredentials: Update a set of Queues credentials. You can update the credentials' name, or their permissions.
17581758
func (s *SqsAPI) UpdateSqsCredentials(req *SqsAPIUpdateSqsCredentialsRequest, opts ...scw.RequestOption) (*SqsCredentials, error) {
17591759
var err error
17601760

@@ -1821,7 +1821,7 @@ func (s *SqsAPI) GetSqsCredentials(req *SqsAPIGetSqsCredentialsRequest, opts ...
18211821
return &resp, nil
18221822
}
18231823

1824-
// ListSqsCredentials: List existing SQS credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
1824+
// ListSqsCredentials: List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
18251825
func (s *SqsAPI) ListSqsCredentials(req *SqsAPIListSqsCredentialsRequest, opts ...scw.RequestOption) (*ListSqsCredentialsResponse, error) {
18261826
var err error
18271827

0 commit comments

Comments
 (0)