Skip to content

Commit 2eb545f

Browse files
scaleway-botscaleway-bot
authored
docs(iam): add enums documentation (#1777)
1 parent 95ba14a commit 2eb545f

File tree

1 file changed

+100
-39
lines changed

1 file changed

+100
-39
lines changed

‎api/iam/v1alpha1/iam_sdk.go‎

Lines changed: 100 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,12 @@ func NewAPI(client *scw.Client) *API {
5454
type BearerType string
5555

5656
const (
57+
// Unknown bearer type
5758
BearerTypeUnknownBearerType = BearerType("unknown_bearer_type")
58-
BearerTypeUser = BearerType("user")
59-
BearerTypeApplication = BearerType("application")
59+
// User
60+
BearerTypeUser = BearerType("user")
61+
// Application
62+
BearerTypeApplication = BearerType("application")
6063
)
6164

6265
func (enum BearerType) String() string {
@@ -85,13 +88,21 @@ func (enum *BearerType) UnmarshalJSON(data []byte) error {
8588
type ListAPIKeysRequestOrderBy string
8689

8790
const (
88-
ListAPIKeysRequestOrderByCreatedAtAsc = ListAPIKeysRequestOrderBy("created_at_asc")
91+
// Creation date ascending
92+
ListAPIKeysRequestOrderByCreatedAtAsc = ListAPIKeysRequestOrderBy("created_at_asc")
93+
// Creation date descending
8994
ListAPIKeysRequestOrderByCreatedAtDesc = ListAPIKeysRequestOrderBy("created_at_desc")
90-
ListAPIKeysRequestOrderByUpdatedAtAsc = ListAPIKeysRequestOrderBy("updated_at_asc")
95+
// Update date ascending
96+
ListAPIKeysRequestOrderByUpdatedAtAsc = ListAPIKeysRequestOrderBy("updated_at_asc")
97+
// Update date descending
9198
ListAPIKeysRequestOrderByUpdatedAtDesc = ListAPIKeysRequestOrderBy("updated_at_desc")
92-
ListAPIKeysRequestOrderByExpiresAtAsc = ListAPIKeysRequestOrderBy("expires_at_asc")
99+
// Expiration date ascending
100+
ListAPIKeysRequestOrderByExpiresAtAsc = ListAPIKeysRequestOrderBy("expires_at_asc")
101+
// Expiration date descending
93102
ListAPIKeysRequestOrderByExpiresAtDesc = ListAPIKeysRequestOrderBy("expires_at_desc")
94-
ListAPIKeysRequestOrderByAccessKeyAsc = ListAPIKeysRequestOrderBy("access_key_asc")
103+
// Access key ascending
104+
ListAPIKeysRequestOrderByAccessKeyAsc = ListAPIKeysRequestOrderBy("access_key_asc")
105+
// Access key descending
95106
ListAPIKeysRequestOrderByAccessKeyDesc = ListAPIKeysRequestOrderBy("access_key_desc")
96107
)
97108

@@ -121,12 +132,18 @@ func (enum *ListAPIKeysRequestOrderBy) UnmarshalJSON(data []byte) error {
121132
type ListApplicationsRequestOrderBy string
122133

123134
const (
124-
ListApplicationsRequestOrderByCreatedAtAsc = ListApplicationsRequestOrderBy("created_at_asc")
135+
// Creation date ascending
136+
ListApplicationsRequestOrderByCreatedAtAsc = ListApplicationsRequestOrderBy("created_at_asc")
137+
// Creation date descending
125138
ListApplicationsRequestOrderByCreatedAtDesc = ListApplicationsRequestOrderBy("created_at_desc")
126-
ListApplicationsRequestOrderByUpdatedAtAsc = ListApplicationsRequestOrderBy("updated_at_asc")
139+
// Update date ascending
140+
ListApplicationsRequestOrderByUpdatedAtAsc = ListApplicationsRequestOrderBy("updated_at_asc")
141+
// Update date descending
127142
ListApplicationsRequestOrderByUpdatedAtDesc = ListApplicationsRequestOrderBy("updated_at_desc")
128-
ListApplicationsRequestOrderByNameAsc = ListApplicationsRequestOrderBy("name_asc")
129-
ListApplicationsRequestOrderByNameDesc = ListApplicationsRequestOrderBy("name_desc")
143+
// Name ascending
144+
ListApplicationsRequestOrderByNameAsc = ListApplicationsRequestOrderBy("name_asc")
145+
// Name descending
146+
ListApplicationsRequestOrderByNameDesc = ListApplicationsRequestOrderBy("name_desc")
130147
)
131148

132149
func (enum ListApplicationsRequestOrderBy) String() string {
@@ -155,12 +172,18 @@ func (enum *ListApplicationsRequestOrderBy) UnmarshalJSON(data []byte) error {
155172
type ListGroupsRequestOrderBy string
156173

157174
const (
158-
ListGroupsRequestOrderByCreatedAtAsc = ListGroupsRequestOrderBy("created_at_asc")
175+
// Creation date ascending
176+
ListGroupsRequestOrderByCreatedAtAsc = ListGroupsRequestOrderBy("created_at_asc")
177+
// Creation date descending
159178
ListGroupsRequestOrderByCreatedAtDesc = ListGroupsRequestOrderBy("created_at_desc")
160-
ListGroupsRequestOrderByUpdatedAtAsc = ListGroupsRequestOrderBy("updated_at_asc")
179+
// Update date ascending
180+
ListGroupsRequestOrderByUpdatedAtAsc = ListGroupsRequestOrderBy("updated_at_asc")
181+
// Update date descending
161182
ListGroupsRequestOrderByUpdatedAtDesc = ListGroupsRequestOrderBy("updated_at_desc")
162-
ListGroupsRequestOrderByNameAsc = ListGroupsRequestOrderBy("name_asc")
163-
ListGroupsRequestOrderByNameDesc = ListGroupsRequestOrderBy("name_desc")
183+
// Name ascending
184+
ListGroupsRequestOrderByNameAsc = ListGroupsRequestOrderBy("name_asc")
185+
// Name descending
186+
ListGroupsRequestOrderByNameDesc = ListGroupsRequestOrderBy("name_desc")
164187
)
165188

166189
func (enum ListGroupsRequestOrderBy) String() string {
@@ -189,9 +212,13 @@ func (enum *ListGroupsRequestOrderBy) UnmarshalJSON(data []byte) error {
189212
type ListJWTsRequestOrderBy string
190213

191214
const (
192-
ListJWTsRequestOrderByCreatedAtAsc = ListJWTsRequestOrderBy("created_at_asc")
215+
// Creation date ascending
216+
ListJWTsRequestOrderByCreatedAtAsc = ListJWTsRequestOrderBy("created_at_asc")
217+
// Creation date descending
193218
ListJWTsRequestOrderByCreatedAtDesc = ListJWTsRequestOrderBy("created_at_desc")
194-
ListJWTsRequestOrderByUpdatedAtAsc = ListJWTsRequestOrderBy("updated_at_asc")
219+
// Update date ascending
220+
ListJWTsRequestOrderByUpdatedAtAsc = ListJWTsRequestOrderBy("updated_at_asc")
221+
// Update date descending
195222
ListJWTsRequestOrderByUpdatedAtDesc = ListJWTsRequestOrderBy("updated_at_desc")
196223
)
197224

@@ -221,9 +248,13 @@ func (enum *ListJWTsRequestOrderBy) UnmarshalJSON(data []byte) error {
221248
type ListPermissionSetsRequestOrderBy string
222249

223250
const (
224-
ListPermissionSetsRequestOrderByNameAsc = ListPermissionSetsRequestOrderBy("name_asc")
225-
ListPermissionSetsRequestOrderByNameDesc = ListPermissionSetsRequestOrderBy("name_desc")
226-
ListPermissionSetsRequestOrderByCreatedAtAsc = ListPermissionSetsRequestOrderBy("created_at_asc")
251+
// Name ascending
252+
ListPermissionSetsRequestOrderByNameAsc = ListPermissionSetsRequestOrderBy("name_asc")
253+
// Name descending
254+
ListPermissionSetsRequestOrderByNameDesc = ListPermissionSetsRequestOrderBy("name_desc")
255+
// Creation date ascending
256+
ListPermissionSetsRequestOrderByCreatedAtAsc = ListPermissionSetsRequestOrderBy("created_at_asc")
257+
// Creation date descending
227258
ListPermissionSetsRequestOrderByCreatedAtDesc = ListPermissionSetsRequestOrderBy("created_at_desc")
228259
)
229260

@@ -253,10 +284,14 @@ func (enum *ListPermissionSetsRequestOrderBy) UnmarshalJSON(data []byte) error {
253284
type ListPoliciesRequestOrderBy string
254285

255286
const (
256-
ListPoliciesRequestOrderByPolicyNameAsc = ListPoliciesRequestOrderBy("policy_name_asc")
287+
// Policy name ascending
288+
ListPoliciesRequestOrderByPolicyNameAsc = ListPoliciesRequestOrderBy("policy_name_asc")
289+
// Policy name descending
257290
ListPoliciesRequestOrderByPolicyNameDesc = ListPoliciesRequestOrderBy("policy_name_desc")
258-
ListPoliciesRequestOrderByCreatedAtAsc = ListPoliciesRequestOrderBy("created_at_asc")
259-
ListPoliciesRequestOrderByCreatedAtDesc = ListPoliciesRequestOrderBy("created_at_desc")
291+
// Creation date ascending
292+
ListPoliciesRequestOrderByCreatedAtAsc = ListPoliciesRequestOrderBy("created_at_asc")
293+
// Creation date descending
294+
ListPoliciesRequestOrderByCreatedAtDesc = ListPoliciesRequestOrderBy("created_at_desc")
260295
)
261296

262297
func (enum ListPoliciesRequestOrderBy) String() string {
@@ -285,7 +320,9 @@ func (enum *ListPoliciesRequestOrderBy) UnmarshalJSON(data []byte) error {
285320
type ListQuotaRequestOrderBy string
286321

287322
const (
288-
ListQuotaRequestOrderByNameAsc = ListQuotaRequestOrderBy("name_asc")
323+
// Name ascending
324+
ListQuotaRequestOrderByNameAsc = ListQuotaRequestOrderBy("name_asc")
325+
// Name descending
289326
ListQuotaRequestOrderByNameDesc = ListQuotaRequestOrderBy("name_desc")
290327
)
291328

@@ -315,12 +352,18 @@ func (enum *ListQuotaRequestOrderBy) UnmarshalJSON(data []byte) error {
315352
type ListSSHKeysRequestOrderBy string
316353

317354
const (
318-
ListSSHKeysRequestOrderByCreatedAtAsc = ListSSHKeysRequestOrderBy("created_at_asc")
355+
// Creation date ascending
356+
ListSSHKeysRequestOrderByCreatedAtAsc = ListSSHKeysRequestOrderBy("created_at_asc")
357+
// Creation date descending
319358
ListSSHKeysRequestOrderByCreatedAtDesc = ListSSHKeysRequestOrderBy("created_at_desc")
320-
ListSSHKeysRequestOrderByUpdatedAtAsc = ListSSHKeysRequestOrderBy("updated_at_asc")
359+
// Update date ascending
360+
ListSSHKeysRequestOrderByUpdatedAtAsc = ListSSHKeysRequestOrderBy("updated_at_asc")
361+
// Update date descending
321362
ListSSHKeysRequestOrderByUpdatedAtDesc = ListSSHKeysRequestOrderBy("updated_at_desc")
322-
ListSSHKeysRequestOrderByNameAsc = ListSSHKeysRequestOrderBy("name_asc")
323-
ListSSHKeysRequestOrderByNameDesc = ListSSHKeysRequestOrderBy("name_desc")
363+
// Name ascending
364+
ListSSHKeysRequestOrderByNameAsc = ListSSHKeysRequestOrderBy("name_asc")
365+
// Name descending
366+
ListSSHKeysRequestOrderByNameDesc = ListSSHKeysRequestOrderBy("name_desc")
324367
)
325368

326369
func (enum ListSSHKeysRequestOrderBy) String() string {
@@ -349,13 +392,21 @@ func (enum *ListSSHKeysRequestOrderBy) UnmarshalJSON(data []byte) error {
349392
type ListUsersRequestOrderBy string
350393

351394
const (
352-
ListUsersRequestOrderByCreatedAtAsc = ListUsersRequestOrderBy("created_at_asc")
395+
// Creation date ascending
396+
ListUsersRequestOrderByCreatedAtAsc = ListUsersRequestOrderBy("created_at_asc")
397+
// Creation date descending
353398
ListUsersRequestOrderByCreatedAtDesc = ListUsersRequestOrderBy("created_at_desc")
354-
ListUsersRequestOrderByUpdatedAtAsc = ListUsersRequestOrderBy("updated_at_asc")
399+
// Update date ascending
400+
ListUsersRequestOrderByUpdatedAtAsc = ListUsersRequestOrderBy("updated_at_asc")
401+
// Update date descending
355402
ListUsersRequestOrderByUpdatedAtDesc = ListUsersRequestOrderBy("updated_at_desc")
356-
ListUsersRequestOrderByEmailAsc = ListUsersRequestOrderBy("email_asc")
357-
ListUsersRequestOrderByEmailDesc = ListUsersRequestOrderBy("email_desc")
358-
ListUsersRequestOrderByLastLoginAsc = ListUsersRequestOrderBy("last_login_asc")
403+
// Email ascending
404+
ListUsersRequestOrderByEmailAsc = ListUsersRequestOrderBy("email_asc")
405+
// Email descending
406+
ListUsersRequestOrderByEmailDesc = ListUsersRequestOrderBy("email_desc")
407+
// Last login ascending
408+
ListUsersRequestOrderByLastLoginAsc = ListUsersRequestOrderBy("last_login_asc")
409+
// Last login descending
359410
ListUsersRequestOrderByLastLoginDesc = ListUsersRequestOrderBy("last_login_desc")
360411
)
361412

@@ -385,10 +436,14 @@ func (enum *ListUsersRequestOrderBy) UnmarshalJSON(data []byte) error {
385436
type PermissionSetScopeType string
386437

387438
const (
439+
// Unknown scope type
388440
PermissionSetScopeTypeUnknownScopeType = PermissionSetScopeType("unknown_scope_type")
389-
PermissionSetScopeTypeProjects = PermissionSetScopeType("projects")
390-
PermissionSetScopeTypeOrganization = PermissionSetScopeType("organization")
391-
PermissionSetScopeTypeAccountRootUser = PermissionSetScopeType("account_root_user")
441+
// Projects
442+
PermissionSetScopeTypeProjects = PermissionSetScopeType("projects")
443+
// Organization
444+
PermissionSetScopeTypeOrganization = PermissionSetScopeType("organization")
445+
// Account root user
446+
PermissionSetScopeTypeAccountRootUser = PermissionSetScopeType("account_root_user")
392447
)
393448

394449
func (enum PermissionSetScopeType) String() string {
@@ -417,9 +472,12 @@ func (enum *PermissionSetScopeType) UnmarshalJSON(data []byte) error {
417472
type UserStatus string
418473

419474
const (
420-
UserStatusUnknownStatus = UserStatus("unknown_status")
475+
// Unknown status
476+
UserStatusUnknownStatus = UserStatus("unknown_status")
477+
// Invitation pending
421478
UserStatusInvitationPending = UserStatus("invitation_pending")
422-
UserStatusActivated = UserStatus("activated")
479+
// Activated
480+
UserStatusActivated = UserStatus("activated")
423481
)
424482

425483
func (enum UserStatus) String() string {
@@ -448,9 +506,12 @@ func (enum *UserStatus) UnmarshalJSON(data []byte) error {
448506
type UserType string
449507

450508
const (
509+
// Unknown type
451510
UserTypeUnknownType = UserType("unknown_type")
452-
UserTypeGuest = UserType("guest")
453-
UserTypeOwner = UserType("owner")
511+
// Guest
512+
UserTypeGuest = UserType("guest")
513+
// Owner
514+
UserTypeOwner = UserType("owner")
454515
)
455516

456517
func (enum UserType) String() string {

0 commit comments

Comments
 (0)