Skip to content

Commit b9ba351

Browse files
authored
docs(mnq): add enum documentation (#1700)
1 parent b14c456 commit b9ba351

File tree

1 file changed

+29
-12
lines changed

1 file changed

+29
-12
lines changed

api/mnq/v1alpha1/mnq_sdk.go

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,13 @@ func NewAPI(client *scw.Client) *API {
5555
type ListCredentialsRequestOrderBy string
5656

5757
const (
58-
ListCredentialsRequestOrderByIDAsc = ListCredentialsRequestOrderBy("id_asc")
59-
ListCredentialsRequestOrderByIDDesc = ListCredentialsRequestOrderBy("id_desc")
60-
ListCredentialsRequestOrderByNameAsc = ListCredentialsRequestOrderBy("name_asc")
58+
// Order by id (ascending alphabetical order)
59+
ListCredentialsRequestOrderByIDAsc = ListCredentialsRequestOrderBy("id_asc")
60+
// Order by id (descending alphabetical order)
61+
ListCredentialsRequestOrderByIDDesc = ListCredentialsRequestOrderBy("id_desc")
62+
// Order by name (ascending alphabetical order)
63+
ListCredentialsRequestOrderByNameAsc = ListCredentialsRequestOrderBy("name_asc")
64+
// Order by name (descending alphabetical order)
6165
ListCredentialsRequestOrderByNameDesc = ListCredentialsRequestOrderBy("name_desc")
6266
)
6367

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

8993
const (
90-
ListNamespacesRequestOrderByCreatedAtAsc = ListNamespacesRequestOrderBy("created_at_asc")
94+
// Order by creation date (ascending chronological order)
95+
ListNamespacesRequestOrderByCreatedAtAsc = ListNamespacesRequestOrderBy("created_at_asc")
96+
// Order by creation date (descending chronological order)
9197
ListNamespacesRequestOrderByCreatedAtDesc = ListNamespacesRequestOrderBy("created_at_desc")
92-
ListNamespacesRequestOrderByUpdatedAtAsc = ListNamespacesRequestOrderBy("updated_at_asc")
98+
// Order by last update date (ascending chronological order)
99+
ListNamespacesRequestOrderByUpdatedAtAsc = ListNamespacesRequestOrderBy("updated_at_asc")
100+
// Order by last update date (descending chronological order)
93101
ListNamespacesRequestOrderByUpdatedAtDesc = ListNamespacesRequestOrderBy("updated_at_desc")
94-
ListNamespacesRequestOrderByIDAsc = ListNamespacesRequestOrderBy("id_asc")
95-
ListNamespacesRequestOrderByIDDesc = ListNamespacesRequestOrderBy("id_desc")
96-
ListNamespacesRequestOrderByNameAsc = ListNamespacesRequestOrderBy("name_asc")
97-
ListNamespacesRequestOrderByNameDesc = ListNamespacesRequestOrderBy("name_desc")
98-
ListNamespacesRequestOrderByProjectIDAsc = ListNamespacesRequestOrderBy("project_id_asc")
102+
// Order by id (ascending alphabetical order)
103+
ListNamespacesRequestOrderByIDAsc = ListNamespacesRequestOrderBy("id_asc")
104+
// Order by id (descending alphabetical order)
105+
ListNamespacesRequestOrderByIDDesc = ListNamespacesRequestOrderBy("id_desc")
106+
// Order by name (ascending alphabetical order)
107+
ListNamespacesRequestOrderByNameAsc = ListNamespacesRequestOrderBy("name_asc")
108+
// Order by name (descending alphabetical order)
109+
ListNamespacesRequestOrderByNameDesc = ListNamespacesRequestOrderBy("name_desc")
110+
// Order by project_id (ascending alphabetical order)
111+
ListNamespacesRequestOrderByProjectIDAsc = ListNamespacesRequestOrderBy("project_id_asc")
112+
// Order by project_id (descending alphabetical order)
99113
ListNamespacesRequestOrderByProjectIDDesc = ListNamespacesRequestOrderBy("project_id_desc")
100114
)
101115

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

127141
const (
142+
// Unknown protocol
128143
NamespaceProtocolUnknown = NamespaceProtocol("unknown")
129-
NamespaceProtocolNats = NamespaceProtocol("nats")
130-
NamespaceProtocolSqsSns = NamespaceProtocol("sqs_sns")
144+
// NATS protocol
145+
NamespaceProtocolNats = NamespaceProtocol("nats")
146+
// SQS / SNS protocol
147+
NamespaceProtocolSqsSns = NamespaceProtocol("sqs_sns")
131148
)
132149

133150
func (enum NamespaceProtocol) String() string {

0 commit comments

Comments
 (0)