Skip to content

Commit

Permalink
docs(mnq): add enum documentation (#1700)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored May 24, 2023
1 parent b14c456 commit b9ba351
Showing 1 changed file with 29 additions and 12 deletions.
41 changes: 29 additions & 12 deletions api/mnq/v1alpha1/mnq_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,13 @@ func NewAPI(client *scw.Client) *API {
type ListCredentialsRequestOrderBy string

const (
ListCredentialsRequestOrderByIDAsc = ListCredentialsRequestOrderBy("id_asc")
ListCredentialsRequestOrderByIDDesc = ListCredentialsRequestOrderBy("id_desc")
ListCredentialsRequestOrderByNameAsc = ListCredentialsRequestOrderBy("name_asc")
// Order by id (ascending alphabetical order)
ListCredentialsRequestOrderByIDAsc = ListCredentialsRequestOrderBy("id_asc")
// Order by id (descending alphabetical order)
ListCredentialsRequestOrderByIDDesc = ListCredentialsRequestOrderBy("id_desc")
// Order by name (ascending alphabetical order)
ListCredentialsRequestOrderByNameAsc = ListCredentialsRequestOrderBy("name_asc")
// Order by name (descending alphabetical order)
ListCredentialsRequestOrderByNameDesc = ListCredentialsRequestOrderBy("name_desc")
)

Expand Down Expand Up @@ -87,15 +91,25 @@ func (enum *ListCredentialsRequestOrderBy) UnmarshalJSON(data []byte) error {
type ListNamespacesRequestOrderBy string

const (
ListNamespacesRequestOrderByCreatedAtAsc = ListNamespacesRequestOrderBy("created_at_asc")
// Order by creation date (ascending chronological order)
ListNamespacesRequestOrderByCreatedAtAsc = ListNamespacesRequestOrderBy("created_at_asc")
// Order by creation date (descending chronological order)
ListNamespacesRequestOrderByCreatedAtDesc = ListNamespacesRequestOrderBy("created_at_desc")
ListNamespacesRequestOrderByUpdatedAtAsc = ListNamespacesRequestOrderBy("updated_at_asc")
// Order by last update date (ascending chronological order)
ListNamespacesRequestOrderByUpdatedAtAsc = ListNamespacesRequestOrderBy("updated_at_asc")
// Order by last update date (descending chronological order)
ListNamespacesRequestOrderByUpdatedAtDesc = ListNamespacesRequestOrderBy("updated_at_desc")
ListNamespacesRequestOrderByIDAsc = ListNamespacesRequestOrderBy("id_asc")
ListNamespacesRequestOrderByIDDesc = ListNamespacesRequestOrderBy("id_desc")
ListNamespacesRequestOrderByNameAsc = ListNamespacesRequestOrderBy("name_asc")
ListNamespacesRequestOrderByNameDesc = ListNamespacesRequestOrderBy("name_desc")
ListNamespacesRequestOrderByProjectIDAsc = ListNamespacesRequestOrderBy("project_id_asc")
// Order by id (ascending alphabetical order)
ListNamespacesRequestOrderByIDAsc = ListNamespacesRequestOrderBy("id_asc")
// Order by id (descending alphabetical order)
ListNamespacesRequestOrderByIDDesc = ListNamespacesRequestOrderBy("id_desc")
// Order by name (ascending alphabetical order)
ListNamespacesRequestOrderByNameAsc = ListNamespacesRequestOrderBy("name_asc")
// Order by name (descending alphabetical order)
ListNamespacesRequestOrderByNameDesc = ListNamespacesRequestOrderBy("name_desc")
// Order by project_id (ascending alphabetical order)
ListNamespacesRequestOrderByProjectIDAsc = ListNamespacesRequestOrderBy("project_id_asc")
// Order by project_id (descending alphabetical order)
ListNamespacesRequestOrderByProjectIDDesc = ListNamespacesRequestOrderBy("project_id_desc")
)

Expand Down Expand Up @@ -125,9 +139,12 @@ func (enum *ListNamespacesRequestOrderBy) UnmarshalJSON(data []byte) error {
type NamespaceProtocol string

const (
// Unknown protocol
NamespaceProtocolUnknown = NamespaceProtocol("unknown")
NamespaceProtocolNats = NamespaceProtocol("nats")
NamespaceProtocolSqsSns = NamespaceProtocol("sqs_sns")
// NATS protocol
NamespaceProtocolNats = NamespaceProtocol("nats")
// SQS / SNS protocol
NamespaceProtocolSqsSns = NamespaceProtocol("sqs_sns")
)

func (enum NamespaceProtocol) String() string {
Expand Down

0 comments on commit b9ba351

Please sign in to comment.