pub.chive.discovery.getCitations
Schema Diff
+26 -0
Compatibility Analysis
Backward Compatible
Backward compatible. 13 non-breaking changes.
Non-Breaking Changes (13)
- AddedVertex AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.authors" }
- AddedVertex AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.authors:items" }
- AddedVertex AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.venue" }
- AddedVertex AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.year" }
- AddedVertex AddedVertex { vertex_id: "pub.chive.discovery.getCitations:output.papers" }
- AddedVertex AddedVertex { vertex_id: "pub.chive.discovery.getCitations:output.papers:items" }
- AddedEdge AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef", tgt: "pub.chive.discovery.getCitations#eprintRef.authors", kind: "prop", name: Some("authors") }
- AddedEdge AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef", tgt: "pub.chive.discovery.getCitations#eprintRef.venue", kind: "prop", name: Some("venue") }
- AddedEdge AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef", tgt: "pub.chive.discovery.getCitations#eprintRef.year", kind: "prop", name: Some("year") }
- AddedEdge AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef.authors", tgt: "pub.chive.discovery.getCitations#eprintRef.authors:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "pub.chive.discovery.getCitations:output", tgt: "pub.chive.discovery.getCitations:output.papers", kind: "prop", name: Some("papers") }
- AddedEdge AddedEdge { src: "pub.chive.discovery.getCitations:output.papers", tgt: "pub.chive.discovery.getCitations:output.papers:items", kind: "items", name: None }
- AddedEdge AddedEdge { src: "pub.chive.discovery.getCitations:output.papers:items", tgt: "pub.chive.discovery.getCitations#eprintRef", kind: "ref", name: None }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.authors" }AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.authors:items" }AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.venue" }AddedVertex { vertex_id: "pub.chive.discovery.getCitations#eprintRef.year" }AddedVertex { vertex_id: "pub.chive.discovery.getCitations:output.papers" }AddedVertex { vertex_id: "pub.chive.discovery.getCitations:output.papers:items" }
Additional Notes
- Non-breaking: AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef", tgt: "pub.chive.discovery.getCitations#eprintRef.authors", kind: "prop", name: Some("authors") }
- Non-breaking: AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef", tgt: "pub.chive.discovery.getCitations#eprintRef.venue", kind: "prop", name: Some("venue") }
- Non-breaking: AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef", tgt: "pub.chive.discovery.getCitations#eprintRef.year", kind: "prop", name: Some("year") }
- Non-breaking: AddedEdge { src: "pub.chive.discovery.getCitations#eprintRef.authors", tgt: "pub.chive.discovery.getCitations#eprintRef.authors:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "pub.chive.discovery.getCitations:output", tgt: "pub.chive.discovery.getCitations:output.papers", kind: "prop", name: Some("papers") }
- Non-breaking: AddedEdge { src: "pub.chive.discovery.getCitations:output.papers", tgt: "pub.chive.discovery.getCitations:output.papers:items", kind: "items", name: None }
- Non-breaking: AddedEdge { src: "pub.chive.discovery.getCitations:output.papers:items", tgt: "pub.chive.discovery.getCitations#eprintRef", kind: "ref", name: None }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"citation": {
5
5
"properties": {
6
6
"citedUri": {
7
7
"description": "AT-URI of the cited paper",
8
8
"format": "at-uri",
9
9
"type": "string"
10
10
},
11
11
"citingUri": {
12
12
"description": "AT-URI of the citing paper",
13
13
"format": "at-uri",
14
14
"type": "string"
15
15
},
16
16
"discoveredAt": {
17
17
"description": "When this citation was discovered",
18
18
"format": "datetime",
19
19
"type": "string"
20
20
},
21
21
"isInfluential": {
22
22
"description": "Whether this is an influential citation",
23
23
"type": "boolean"
24
24
},
25
25
"source": {
26
26
"description": "Source of citation data (e.g., semantic-scholar, openalex)",
27
27
"type": "string"
28
28
}
29
29
},
30
30
"required": [
31
31
"citingUri",
32
32
"citedUri",
33
33
"source"
34
34
],
35
35
"type": "object"
36
36
},
37
37
"citationCounts": {
38
38
"properties": {
39
39
"citedByCount": {
40
40
"description": "Number of papers citing this eprint",
41
41
"minimum": 0,
42
42
"type": "integer"
43
43
},
44
44
"influentialCitedByCount": {
45
45
"description": "Number of influential citations",
46
46
"minimum": 0,
47
47
"type": "integer"
48
48
},
49
49
"referencesCount": {
50
50
"description": "Number of papers this eprint references",
51
51
"minimum": 0,
52
52
"type": "integer"
53
53
}
54
54
},
55
55
"required": [
56
56
"citedByCount",
57
57
"referencesCount",
58
58
"influentialCitedByCount"
59
59
],
60
60
"type": "object"
61
61
},
62
62
"eprintRef": {
63
+
"description": "An eprint named well enough to identify it on sight. The citation graph stores only URIs on its nodes, so an edge read back from it carries nothing a reader could recognise.",
63
64
"properties": {
65
+
"authors": {
66
+
"description": "Author names in record order. A citation is identified by who wrote it as much as by its title.",
67
+
"items": {
68
+
"maxLength": 256,
69
+
"type": "string"
70
+
},
71
+
"type": "array"
72
+
},
64
73
"title": {
65
74
"type": "string"
66
75
},
67
76
"uri": {
68
77
"format": "at-uri",
69
78
"type": "string"
79
+
},
80
+
"venue": {
81
+
"description": "Journal or proceedings the eprint appeared in, when known.",
82
+
"maxLength": 512,
83
+
"type": "string"
84
+
},
85
+
"year": {
86
+
"description": "Publication year, when the eprint records a published version.",
87
+
"type": "integer"
70
88
}
71
89
},
72
90
"required": [
73
91
"uri",
74
92
"title"
75
93
],
76
94
"type": "object"
77
95
},
78
96
"main": {
79
97
"description": "Get citation network data for an eprint, including papers that cite it and papers it references (within the Chive index)",
80
98
"errors": [
81
99
{
82
100
"name": "NotFound"
83
101
},
84
102
{
85
103
"name": "ServiceUnavailable"
86
104
}
87
105
],
88
106
"output": {
89
107
"encoding": "application/json",
90
108
"schema": {
91
109
"properties": {
92
110
"citations": {
93
111
"items": {
94
112
"ref": "#citation",
95
113
"type": "ref"
96
114
},
97
115
"type": "array"
98
116
},
99
117
"counts": {
100
118
"ref": "#citationCounts",
101
119
"type": "ref"
102
120
},
103
121
"cursor": {
104
122
"description": "Pagination cursor for next page",
105
123
"type": "string"
106
124
},
107
125
"eprint": {
108
126
"ref": "#eprintRef",
109
127
"type": "ref"
110
128
},
111
129
"hasMore": {
112
130
"description": "Whether more results are available",
113
131
"type": "boolean"
132
+
},
133
+
"papers": {
134
+
"description": "Every eprint appearing at either end of the returned citations, once each. A lookup rather than metadata repeated on each edge: a densely connected paper would otherwise carry the same author list dozens of times in one response.",
135
+
"items": {
136
+
"ref": "#eprintRef",
137
+
"type": "ref"
138
+
},
139
+
"type": "array"
114
140
}
115
141
},
116
142
"required": [
117
143
"eprint",
118
144
"counts",
119
145
"citations",
120
146
"hasMore"
121
147
],
122
148
"type": "object"
123
149
}
124
150
},
125
151
"parameters": {
126
152
"properties": {
127
153
"cursor": {
128
154
"description": "Pagination cursor",
129
155
"type": "string"
130
156
},
131
157
"direction": {
132
158
"default": "both",
133
159
"description": "Citation direction: citing (papers this cites), cited-by (papers citing this), or both",
134
160
"knownValues": [
135
161
"citing",
136
162
"cited-by",
137
163
"both"
138
164
],
139
165
"type": "string"
140
166
},
141
167
"limit": {
142
168
"default": 20,
143
169
"description": "Maximum number of citations to return",
144
170
"maximum": 100,
145
171
"minimum": 1,
146
172
"type": "integer"
147
173
},
148
174
"onlyInfluential": {
149
175
"default": false,
150
176
"description": "Only return influential citations",
151
177
"type": "boolean"
152
178
},
153
179
"uri": {
154
180
"description": "AT-URI of the eprint",
155
181
"format": "at-uri",
156
182
"type": "string"
157
183
}
158
184
},
159
185
"required": [
160
186
"uri"
161
187
],
162
188
"type": "params"
163
189
},
164
190
"type": "query"
165
191
}
166
192
},
167
193
"id": "pub.chive.discovery.getCitations",
168
194
"lexicon": 1,
169
195
"revision": 1
170
196
}