args-api 0.1.0

Shared API contract types and endpoint definitions for args.
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
100
101
102
103
104
105

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use uuid::Uuid;

use crate::resource::repository::{CommitAuthorResource, CommitDiffResource};

#[derive(ApiResource, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UserResource {
    pub id: Uuid,
    pub name: String,

    pub location: Option<String>,
    pub readme: Option<String>,
    pub links: Vec<String>,
    pub display_name: Option<String>,

    pub created_at: DateTime<Utc>,
    pub image_updated_at: DateTime<Utc>,
}

#[derive(ApiResource, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UserEmailResource {
    pub email: String,
    pub is_primary: bool,
    pub is_verified: bool,
    pub created_at: DateTime<Utc>,
}

#[derive(ApiResource, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CurrentUserResource {
    pub id: Uuid,
    pub name: String,
    pub emails: Vec<UserEmailResource>,
    pub memberships: Vec<UserMembershipResource>,

    pub location: Option<String>,
    pub readme: Option<String>,
    pub links: Vec<String>,
    pub display_name: Option<String>,

    pub created_at: DateTime<Utc>,
    pub image_updated_at: DateTime<Utc>,
}

/// An organization as surfaced from a user's perspective. It contains basic org
/// info plus the viewer's own membership metadata (`role`, `joined_at`).
#[derive(ApiResource, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UserMembershipResource {
    pub id: Uuid,
    pub name: String,
    pub display_name: Option<String>,

    pub role: String,
    pub role_description: Option<String>,
    pub joined_at: DateTime<Utc>,
    pub image_updated_at: DateTime<Utc>,
}

/// A repository as surfaced on a user's profile. It contains the viewer-visible
/// subset of repo fields plus the user's contribution stats.
#[derive(ApiResource, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UserRepositoryResource {
    pub owner: String,
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    pub stars: u32,
    pub visibility: String,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub commit_count: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub last_commit_at: Option<DateTime<Utc>>,
}

/// A commit as surfaced on a user's profile. Most fields are optional so that
/// commits in private repositories the viewer cannot access can be returned as
/// a redacted stub (timestamp + `redacted: true` only)
#[derive(ApiResource, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UserCommitResource {
    pub id: Uuid,
    pub date: DateTime<Utc>,
    pub redacted: bool,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub owner_name: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub repo_name: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sha: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub parent_sha: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub author: Option<CommitAuthorResource>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub bug_number: Option<i32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub review_number: Option<i32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub diff_position: Option<i32>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub diffs: Vec<CommitDiffResource>,
}