komodo_client 2.1.0

Client for the Komodo build and deployment system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use mogh_resolver::Resolve;
use serde::{Deserialize, Serialize};
use typeshare::typeshare;

use crate::entities::{
  ResourceTarget,
  permission::{Permission, PermissionLevelAndSpecifics, UserTarget},
};

use super::KomodoReadRequest;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ListPermissions",
  description = "List permissions for the calling user.",
  request_body(content = ListPermissions),
  responses(
    (status = 200, description = "The list of permissions", body = ListPermissionsResponse),
  ),
)]
pub fn list_permissions() {}

/// List permissions for the calling user.
/// Does not include any permissions on UserGroups they may be a part of.
/// Response: [ListPermissionsResponse]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ListPermissionsResponse)]
#[error(mogh_error::Error)]
pub struct ListPermissions {}

#[typeshare]
pub type ListPermissionsResponse = Vec<Permission>;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/GetPermission",
  description = "Gets the calling user's permission level on a specific resource.",
  request_body(content = GetPermission),
  responses(
    (status = 200, description = "The permission level", body = GetPermissionResponse),
  ),
)]
pub fn get_permission() {}

/// Gets the calling user's permission level on a specific resource.
/// Factors in any UserGroup's permissions they may be a part of.
/// Response: [PermissionLevel]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(GetPermissionResponse)]
#[error(mogh_error::Error)]
pub struct GetPermission {
  /// The target to get user permission on.
  pub target: ResourceTarget,
}

#[typeshare]
pub type GetPermissionResponse = PermissionLevelAndSpecifics;

//

#[cfg(feature = "utoipa")]
#[utoipa::path(
  post,
  path = "/ListUserTargetPermissions",
  description = "List permissions for a specific user.",
  request_body(content = ListUserTargetPermissions),
  responses(
    (status = 200, description = "The list of permissions", body = ListUserTargetPermissionsResponse),
  ),
)]
pub fn list_user_target_permissions() {}

/// List permissions for a specific user. **Admin only**.
/// Response: [ListUserTargetPermissionsResponse]
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone, Resolve)]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[empty_traits(KomodoReadRequest)]
#[response(ListUserTargetPermissionsResponse)]
#[error(mogh_error::Error)]
pub struct ListUserTargetPermissions {
  /// Specify either a user or a user group.
  pub user_target: UserTarget,
}

#[typeshare]
pub type ListUserTargetPermissionsResponse = Vec<Permission>;