Skip to content

Commit

Permalink
docs(mnq): clean the doc before going for public beta (#1495)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored Jan 10, 2023
1 parent d6c644c commit 14cf8da
Showing 1 changed file with 3 additions and 29 deletions.
32 changes: 3 additions & 29 deletions api/mnq/v1alpha1/mnq_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,6 @@ const (
NamespaceProtocolNats = NamespaceProtocol("nats")
// NamespaceProtocolSqsSns is [insert doc].
NamespaceProtocolSqsSns = NamespaceProtocol("sqs_sns")
// NamespaceProtocolAmqp is [insert doc].
NamespaceProtocolAmqp = NamespaceProtocol("amqp")
)

func (enum NamespaceProtocol) String() string {
Expand Down Expand Up @@ -184,24 +182,11 @@ type Credential struct {
// Default value: unknown
Protocol NamespaceProtocol `json:"protocol"`
// NatsCredentials: credentials file used to connect to the NATS service
// Precisely one of AmqpCredentials, NatsCredentials, SqsSnsCredentials must be set.
// Precisely one of NatsCredentials, SqsSnsCredentials must be set.
NatsCredentials *CredentialNATSCredsFile `json:"nats_credentials,omitempty"`
// SqsSnsCredentials: credential used to connect to the SQS/SNS service
// Precisely one of AmqpCredentials, NatsCredentials, SqsSnsCredentials must be set.
// Precisely one of NatsCredentials, SqsSnsCredentials must be set.
SqsSnsCredentials *CredentialSQSSNSCreds `json:"sqs_sns_credentials,omitempty"`
// AmqpCredentials: credential used to connect to the AMQP service
// Precisely one of AmqpCredentials, NatsCredentials, SqsSnsCredentials must be set.
AmqpCredentials *CredentialAMQPCreds `json:"amqp_credentials,omitempty"`
}

// CredentialAMQPCreds: credential.amqp creds
type CredentialAMQPCreds struct {
// Username: username used to connect to the AMQP service
Username string `json:"username"`
// Password: password used to connect to the AMQP service
Password *string `json:"password"`
// Permissions: list of permissions associated to this Credential
Permissions *Permissions `json:"permissions"`
}

// CredentialNATSCredsFile: credential.nats creds file
Expand Down Expand Up @@ -233,19 +218,8 @@ type CredentialSummary struct {
// Default value: unknown
Protocol NamespaceProtocol `json:"protocol"`
// SqsSnsCredentials: credential used to connect to the SQS/SNS service
// Precisely one of AmqpCredentials, SqsSnsCredentials must be set.
// Precisely one of SqsSnsCredentials must be set.
SqsSnsCredentials *CredentialSummarySQSSNSCreds `json:"sqs_sns_credentials,omitempty"`
// AmqpCredentials: credential used to connect to the AMQP service
// Precisely one of AmqpCredentials, SqsSnsCredentials must be set.
AmqpCredentials *CredentialSummaryAMQPCreds `json:"amqp_credentials,omitempty"`
}

// CredentialSummaryAMQPCreds: credential summary.amqp creds
type CredentialSummaryAMQPCreds struct {
// Username: username used to connect to the AMQP service
Username string `json:"username"`
// Permissions: list of permissions associated to this Credential
Permissions *Permissions `json:"permissions"`
}

// CredentialSummarySQSSNSCreds: credential summary.sqssns creds
Expand Down

0 comments on commit 14cf8da

Please sign in to comment.