octocrab 0.54.2

A modern, extensible GitHub API client.
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
106
107
108
109
110
111

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use url::Url;

use crate::models::{
    commits::{CommitElement, CommitParent},
    GitUser, LabelId, MinimalRepository, SimpleUser,
};

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SearchResultTextMatch {
    pub fragment: Option<String>,
    pub matches: Option<Vec<Match>>,
    pub object_type: Option<String>,
    pub object_url: Option<String>,
    pub property: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Match {
    pub indices: Option<Vec<i64>>,
    pub text: Option<String>,
}

/// Commit Search Result Item
///  
/// OpenAPI reference: #/components/schemas/commit-search-result-item
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CommitSearchResultItem {
    pub url: Url,
    pub sha: String,
    pub comments_url: Url,
    pub commit: CommitElement,
    pub author: Option<SimpleUser>,
    pub committer: Option<GitUser>,
    pub parents: Vec<CommitParent>,
    pub repository: MinimalRepository,
    pub score: f64,
    pub node_id: String,
    pub text_matches: Option<Vec<SearchResultTextMatch>>,
}

/// Label Search Result Item
///
/// OpenAPI reference: #/components/schemas/label-search-result-item
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct LabelSearchResultItem {
    pub id: LabelId,
    pub node_id: String,
    pub url: Url,
    pub name: String,
    pub color: String,
    pub default: bool,
    pub description: Option<String>,
    pub score: f64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub text_matches: Option<Vec<SearchResultTextMatch>>,
}

/// Topic Search Result Item
///
/// OpenAPI reference: #/components/schemas/topic-search-result-item
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TopicSearchResultItem {
    pub name: String,
    pub display_name: Option<String>,
    pub short_description: Option<String>,
    pub description: Option<String>,
    pub created_by: Option<String>,
    pub released: Option<String>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub featured: bool,
    pub curated: bool,
    pub score: f64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repository_count: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub logo_url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub text_matches: Option<Vec<SearchResultTextMatch>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub related: Option<Vec<TopicRelationItem>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub aliases: Option<Vec<TopicRelationItem>>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TopicRelationItem {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub topic_relation: Option<TopicRelation>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TopicRelation {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub topic_id: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub relation_type: Option<String>,
}