@pg-atlas/data-sdk 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/client/client.gen.js +104 -123
- package/dist/generated/client/index.d.ts +2 -0
- package/dist/generated/client/types.gen.d.ts +6 -3
- package/dist/generated/client/utils.gen.d.ts +8 -4
- package/dist/generated/client/utils.gen.js +3 -3
- package/dist/generated/client.gen.d.ts +2 -2
- package/dist/generated/core/auth.gen.d.ts +7 -0
- package/dist/generated/core/params.gen.d.ts +2 -2
- package/dist/generated/core/params.gen.js +23 -14
- package/dist/generated/core/queryKeySerializer.gen.d.ts +1 -1
- package/dist/generated/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/generated/core/serverSentEvents.gen.js +3 -4
- package/dist/generated/core/types.gen.d.ts +5 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/schemas.gen.d.ts +958 -742
- package/dist/generated/schemas.gen.js +1363 -1091
- package/dist/generated/sdk.gen.d.ts +53 -31
- package/dist/generated/sdk.gen.js +31 -9
- package/dist/generated/types.gen.d.ts +773 -551
- package/package.json +16 -6
|
@@ -2,163 +2,162 @@ export type ClientOptions = {
|
|
|
2
2
|
baseUrl: 'https://api.pgatlas.xyz' | (string & {});
|
|
3
3
|
};
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* ActivityStatus
|
|
6
6
|
*
|
|
7
|
-
*
|
|
7
|
+
* Lifecycle status of a Project.
|
|
8
|
+
*
|
|
9
|
+
* Updated by the SCF Impact Survey (yearly) and higher-frequency signals;
|
|
10
|
+
* see the Activity Status Update Logic in the architecture docs.
|
|
8
11
|
*/
|
|
9
|
-
export type
|
|
12
|
+
export type ActivityStatus = 'live' | 'in-dev' | 'discontinued' | 'non-responsive';
|
|
10
13
|
/**
|
|
11
|
-
*
|
|
14
|
+
* ContributionEntry
|
|
15
|
+
*
|
|
16
|
+
* A single repo that a contributor has committed to.
|
|
12
17
|
*/
|
|
13
|
-
export type
|
|
14
|
-
/**
|
|
15
|
-
* Location
|
|
16
|
-
*/
|
|
17
|
-
loc: Array<string | number>;
|
|
18
|
+
export type ContributionEntry = {
|
|
18
19
|
/**
|
|
19
|
-
*
|
|
20
|
+
* Repo Canonical Id
|
|
20
21
|
*/
|
|
21
|
-
|
|
22
|
+
repo_canonical_id: string;
|
|
22
23
|
/**
|
|
23
|
-
*
|
|
24
|
+
* Repo Display Name
|
|
24
25
|
*/
|
|
25
|
-
|
|
26
|
+
repo_display_name: string;
|
|
26
27
|
/**
|
|
27
|
-
*
|
|
28
|
+
* Project Canonical Id
|
|
28
29
|
*/
|
|
29
|
-
|
|
30
|
+
project_canonical_id: string | null;
|
|
30
31
|
/**
|
|
31
|
-
*
|
|
32
|
+
* Number Of Commits
|
|
32
33
|
*/
|
|
33
|
-
|
|
34
|
-
[key: string]: unknown;
|
|
35
|
-
};
|
|
36
|
-
};
|
|
37
|
-
/**
|
|
38
|
-
* SubmissionStatus
|
|
39
|
-
*
|
|
40
|
-
* Processing state of an artifact-linked audit record.
|
|
41
|
-
*/
|
|
42
|
-
export type SubmissionStatus = 'pending' | 'processed' | 'failed';
|
|
43
|
-
/**
|
|
44
|
-
* ScfSubmission
|
|
45
|
-
*
|
|
46
|
-
* A single SCF funding round submission.
|
|
47
|
-
*/
|
|
48
|
-
export type ScfSubmission = {
|
|
34
|
+
number_of_commits: number;
|
|
49
35
|
/**
|
|
50
|
-
*
|
|
36
|
+
* First Commit Date
|
|
51
37
|
*/
|
|
52
|
-
|
|
38
|
+
first_commit_date: string;
|
|
53
39
|
/**
|
|
54
|
-
*
|
|
40
|
+
* Last Commit Date
|
|
55
41
|
*/
|
|
56
|
-
|
|
42
|
+
last_commit_date: string;
|
|
57
43
|
};
|
|
58
44
|
/**
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
* Full SBOM submission record.
|
|
45
|
+
* ContributorDetailResponse
|
|
62
46
|
*
|
|
63
|
-
*
|
|
64
|
-
* field is the SHA-256 hex digest of the raw submitted payload.
|
|
47
|
+
* Full contributor detail with aggregated statistics and per-repo activity.
|
|
65
48
|
*/
|
|
66
|
-
export type
|
|
49
|
+
export type ContributorDetailResponse = {
|
|
67
50
|
/**
|
|
68
51
|
* Id
|
|
69
52
|
*/
|
|
70
53
|
id: number;
|
|
71
54
|
/**
|
|
72
|
-
*
|
|
55
|
+
* Name
|
|
73
56
|
*/
|
|
74
|
-
|
|
57
|
+
name: string;
|
|
75
58
|
/**
|
|
76
|
-
*
|
|
59
|
+
* Email Hash
|
|
77
60
|
*/
|
|
78
|
-
|
|
61
|
+
email_hash: string;
|
|
79
62
|
/**
|
|
80
|
-
*
|
|
63
|
+
* Total Repos
|
|
81
64
|
*/
|
|
82
|
-
|
|
65
|
+
total_repos: number;
|
|
83
66
|
/**
|
|
84
|
-
*
|
|
67
|
+
* Total Commits
|
|
85
68
|
*/
|
|
86
|
-
|
|
87
|
-
status: SubmissionStatus;
|
|
69
|
+
total_commits: number;
|
|
88
70
|
/**
|
|
89
|
-
*
|
|
71
|
+
* First Contribution
|
|
90
72
|
*/
|
|
91
|
-
|
|
73
|
+
first_contribution: string | null;
|
|
92
74
|
/**
|
|
93
|
-
*
|
|
75
|
+
* Last Contribution
|
|
94
76
|
*/
|
|
95
|
-
|
|
77
|
+
last_contribution: string | null;
|
|
96
78
|
/**
|
|
97
|
-
*
|
|
79
|
+
* Repos
|
|
98
80
|
*/
|
|
99
|
-
|
|
81
|
+
repos: Array<ContributionEntry>;
|
|
100
82
|
};
|
|
101
83
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* Paginated list of SBOM submission records.
|
|
84
|
+
* ContributorSummary
|
|
105
85
|
*
|
|
106
|
-
*
|
|
107
|
-
* any ``repository`` filter has been applied.
|
|
86
|
+
* Compact contributor reference embedded in repo detail responses.
|
|
108
87
|
*/
|
|
109
|
-
export type
|
|
88
|
+
export type ContributorSummary = {
|
|
110
89
|
/**
|
|
111
|
-
*
|
|
90
|
+
* Id
|
|
112
91
|
*/
|
|
113
|
-
|
|
92
|
+
id: number;
|
|
114
93
|
/**
|
|
115
|
-
*
|
|
94
|
+
* Name
|
|
116
95
|
*/
|
|
117
|
-
|
|
96
|
+
name: string;
|
|
118
97
|
/**
|
|
119
|
-
*
|
|
98
|
+
* Email Hash
|
|
120
99
|
*/
|
|
121
|
-
|
|
100
|
+
email_hash: string;
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* DepCounts
|
|
104
|
+
*
|
|
105
|
+
* Counts of dependency edges grouped by target vertex type.
|
|
106
|
+
*
|
|
107
|
+
* Provided as part of the repo detail response so the frontend can show
|
|
108
|
+
* "depends on N repos + M external" without fetching the full edge list.
|
|
109
|
+
*/
|
|
110
|
+
export type DepCounts = {
|
|
122
111
|
/**
|
|
123
|
-
*
|
|
112
|
+
* Repos
|
|
124
113
|
*/
|
|
125
|
-
|
|
114
|
+
repos: number;
|
|
115
|
+
/**
|
|
116
|
+
* External Repos
|
|
117
|
+
*/
|
|
118
|
+
external_repos: number;
|
|
126
119
|
};
|
|
127
120
|
/**
|
|
128
|
-
*
|
|
121
|
+
* EdgeConfidence
|
|
129
122
|
*
|
|
130
|
-
*
|
|
123
|
+
* How firmly an edge was established.
|
|
124
|
+
*/
|
|
125
|
+
export type EdgeConfidence = 'verified-sbom' | 'inferred-shadow';
|
|
126
|
+
/**
|
|
127
|
+
* GitLogArtifactDetailResponse
|
|
131
128
|
*
|
|
132
|
-
*
|
|
133
|
-
* text of the stored SBOM, or ``None`` if the artifact file is missing from
|
|
134
|
-
* the store.
|
|
129
|
+
* Full gitlog artifact audit record including raw artifact content.
|
|
135
130
|
*/
|
|
136
|
-
export type
|
|
131
|
+
export type GitLogArtifactDetailResponse = {
|
|
137
132
|
/**
|
|
138
133
|
* Id
|
|
139
134
|
*/
|
|
140
135
|
id: number;
|
|
141
136
|
/**
|
|
142
|
-
*
|
|
137
|
+
* Repo Id
|
|
143
138
|
*/
|
|
144
|
-
|
|
139
|
+
repo_id: number;
|
|
145
140
|
/**
|
|
146
|
-
*
|
|
141
|
+
* Repo Canonical Id
|
|
147
142
|
*/
|
|
148
|
-
|
|
143
|
+
repo_canonical_id: string;
|
|
149
144
|
/**
|
|
150
|
-
*
|
|
145
|
+
* Repo Display Name
|
|
151
146
|
*/
|
|
152
|
-
|
|
147
|
+
repo_display_name: string;
|
|
153
148
|
/**
|
|
154
149
|
* Artifact Path
|
|
155
150
|
*/
|
|
156
|
-
artifact_path: string;
|
|
151
|
+
artifact_path: string | null;
|
|
157
152
|
status: SubmissionStatus;
|
|
158
153
|
/**
|
|
159
154
|
* Error Detail
|
|
160
155
|
*/
|
|
161
156
|
error_detail: string | null;
|
|
157
|
+
/**
|
|
158
|
+
* Since Months
|
|
159
|
+
*/
|
|
160
|
+
since_months: number;
|
|
162
161
|
/**
|
|
163
162
|
* Submitted At
|
|
164
163
|
*/
|
|
@@ -173,388 +172,460 @@ export type SbomSubmissionDetailResponse = {
|
|
|
173
172
|
raw_artifact?: string | null;
|
|
174
173
|
};
|
|
175
174
|
/**
|
|
176
|
-
*
|
|
175
|
+
* GitLogArtifactSummary
|
|
177
176
|
*
|
|
178
|
-
*
|
|
177
|
+
* Compact gitlog artifact audit record for list endpoints.
|
|
179
178
|
*/
|
|
180
|
-
export type
|
|
179
|
+
export type GitLogArtifactSummary = {
|
|
181
180
|
/**
|
|
182
|
-
*
|
|
181
|
+
* Id
|
|
183
182
|
*/
|
|
184
|
-
|
|
183
|
+
id: number;
|
|
185
184
|
/**
|
|
186
|
-
*
|
|
185
|
+
* Repo Id
|
|
187
186
|
*/
|
|
188
|
-
|
|
187
|
+
repo_id: number;
|
|
189
188
|
/**
|
|
190
|
-
*
|
|
189
|
+
* Repo Canonical Id
|
|
191
190
|
*/
|
|
192
|
-
|
|
193
|
-
};
|
|
194
|
-
/**
|
|
195
|
-
* RepoVertexType
|
|
196
|
-
*
|
|
197
|
-
* Discriminator values for the RepoVertex joined-table-inheritance hierarchy.
|
|
198
|
-
*/
|
|
199
|
-
export type RepoVertexType = 'repo' | 'external-repo';
|
|
200
|
-
/**
|
|
201
|
-
* RepoSummary
|
|
202
|
-
*
|
|
203
|
-
* Compact repo representation used in list endpoints and as an embedded
|
|
204
|
-
* reference in project detail responses.
|
|
205
|
-
*/
|
|
206
|
-
export type RepoSummary = {
|
|
191
|
+
repo_canonical_id: string;
|
|
207
192
|
/**
|
|
208
|
-
*
|
|
193
|
+
* Repo Display Name
|
|
209
194
|
*/
|
|
210
|
-
|
|
195
|
+
repo_display_name: string;
|
|
211
196
|
/**
|
|
212
|
-
*
|
|
197
|
+
* Artifact Path
|
|
213
198
|
*/
|
|
214
|
-
|
|
215
|
-
|
|
199
|
+
artifact_path: string | null;
|
|
200
|
+
status: SubmissionStatus;
|
|
216
201
|
/**
|
|
217
|
-
*
|
|
202
|
+
* Error Detail
|
|
218
203
|
*/
|
|
219
|
-
|
|
204
|
+
error_detail: string | null;
|
|
220
205
|
/**
|
|
221
|
-
*
|
|
206
|
+
* Since Months
|
|
222
207
|
*/
|
|
223
|
-
|
|
208
|
+
since_months: number;
|
|
224
209
|
/**
|
|
225
|
-
*
|
|
210
|
+
* Submitted At
|
|
226
211
|
*/
|
|
227
|
-
|
|
212
|
+
submitted_at: string;
|
|
228
213
|
/**
|
|
229
|
-
*
|
|
214
|
+
* Processed At
|
|
230
215
|
*/
|
|
231
|
-
|
|
216
|
+
processed_at: string | null;
|
|
217
|
+
};
|
|
218
|
+
/**
|
|
219
|
+
* GithubDependentObservationItem
|
|
220
|
+
*
|
|
221
|
+
* One active GitHub dependent observation for a source repo.
|
|
222
|
+
*/
|
|
223
|
+
export type GithubDependentObservationItem = {
|
|
232
224
|
/**
|
|
233
|
-
*
|
|
225
|
+
* Dependent Canonical Id
|
|
234
226
|
*/
|
|
235
|
-
|
|
227
|
+
dependent_canonical_id: string;
|
|
236
228
|
/**
|
|
237
|
-
*
|
|
229
|
+
* Dependent Repo Url
|
|
238
230
|
*/
|
|
239
|
-
|
|
231
|
+
dependent_repo_url: string;
|
|
240
232
|
/**
|
|
241
|
-
*
|
|
233
|
+
* Observed Owner
|
|
242
234
|
*/
|
|
243
|
-
|
|
235
|
+
observed_owner: string;
|
|
244
236
|
/**
|
|
245
|
-
*
|
|
237
|
+
* Observed Repo Name
|
|
246
238
|
*/
|
|
247
|
-
|
|
239
|
+
observed_repo_name: string;
|
|
248
240
|
/**
|
|
249
|
-
*
|
|
241
|
+
* Resolved Repo Canonical Id
|
|
250
242
|
*/
|
|
251
|
-
|
|
243
|
+
resolved_repo_canonical_id?: string | null;
|
|
252
244
|
/**
|
|
253
|
-
*
|
|
245
|
+
* Package Ids
|
|
254
246
|
*/
|
|
255
|
-
|
|
247
|
+
package_ids?: Array<string> | null;
|
|
248
|
+
/**
|
|
249
|
+
* First Seen At
|
|
250
|
+
*/
|
|
251
|
+
first_seen_at: string;
|
|
252
|
+
/**
|
|
253
|
+
* Last Seen At
|
|
254
|
+
*/
|
|
255
|
+
last_seen_at: string;
|
|
256
256
|
};
|
|
257
257
|
/**
|
|
258
|
-
*
|
|
258
|
+
* GithubDependentsResponse
|
|
259
259
|
*
|
|
260
|
-
*
|
|
261
|
-
* and active contributor stats.
|
|
260
|
+
* Summary plus paginated active observations for one source repo.
|
|
262
261
|
*/
|
|
263
|
-
export type
|
|
262
|
+
export type GithubDependentsResponse = {
|
|
263
|
+
summary: GithubDependentsSummary;
|
|
264
|
+
observations: PaginatedResponseGithubDependentObservationItem;
|
|
265
|
+
};
|
|
266
|
+
/**
|
|
267
|
+
* GithubDependentsSummary
|
|
268
|
+
*
|
|
269
|
+
* Freshness and completeness summary for a source repo's observations.
|
|
270
|
+
*
|
|
271
|
+
* ``observations_as_of`` is the finish time of the latest applied
|
|
272
|
+
* listing-complete run; ``reported_counts_as_of`` is the finish time of the
|
|
273
|
+
* latest applied counts-complete run. The two can point to different runs,
|
|
274
|
+
* so the reported totals always carry their own timestamp. Reported header
|
|
275
|
+
* totals may exceed the enumerable public entries and, for multi-package
|
|
276
|
+
* repositories, are per-package sums that can double count a dependent
|
|
277
|
+
* using several packages.
|
|
278
|
+
*/
|
|
279
|
+
export type GithubDependentsSummary = {
|
|
264
280
|
/**
|
|
265
|
-
*
|
|
281
|
+
* Latest Attempt At
|
|
266
282
|
*/
|
|
267
|
-
|
|
283
|
+
latest_attempt_at?: string | null;
|
|
268
284
|
/**
|
|
269
|
-
*
|
|
285
|
+
* Latest Attempt Status
|
|
270
286
|
*/
|
|
271
|
-
|
|
272
|
-
visibility: Visibility;
|
|
287
|
+
latest_attempt_status?: string | null;
|
|
273
288
|
/**
|
|
274
|
-
* Latest
|
|
289
|
+
* Latest Attempt Listing Incomplete Reason
|
|
275
290
|
*/
|
|
276
|
-
|
|
291
|
+
latest_attempt_listing_incomplete_reason?: string | null;
|
|
277
292
|
/**
|
|
278
|
-
* Latest
|
|
293
|
+
* Latest Attempt Counts Incomplete Reason
|
|
279
294
|
*/
|
|
280
|
-
|
|
295
|
+
latest_attempt_counts_incomplete_reason?: string | null;
|
|
281
296
|
/**
|
|
282
|
-
*
|
|
297
|
+
* Observations As Of
|
|
283
298
|
*/
|
|
284
|
-
|
|
299
|
+
observations_as_of?: string | null;
|
|
285
300
|
/**
|
|
286
|
-
*
|
|
301
|
+
* Reported Counts As Of
|
|
287
302
|
*/
|
|
288
|
-
|
|
303
|
+
reported_counts_as_of?: string | null;
|
|
289
304
|
/**
|
|
290
|
-
*
|
|
305
|
+
* Repos Total Reported
|
|
291
306
|
*/
|
|
292
|
-
|
|
307
|
+
repos_total_reported?: number | null;
|
|
293
308
|
/**
|
|
294
|
-
*
|
|
309
|
+
* Packages Total Reported
|
|
295
310
|
*/
|
|
296
|
-
|
|
311
|
+
packages_total_reported?: number | null;
|
|
297
312
|
/**
|
|
298
|
-
*
|
|
313
|
+
* Packages Scanned
|
|
299
314
|
*/
|
|
300
|
-
|
|
315
|
+
packages_scanned?: number | null;
|
|
301
316
|
/**
|
|
302
|
-
*
|
|
317
|
+
* Active Observations
|
|
303
318
|
*/
|
|
304
|
-
|
|
319
|
+
active_observations?: number;
|
|
320
|
+
};
|
|
321
|
+
/**
|
|
322
|
+
* HTTPValidationError
|
|
323
|
+
*/
|
|
324
|
+
export type HttpValidationError = {
|
|
305
325
|
/**
|
|
306
|
-
*
|
|
326
|
+
* Detail
|
|
307
327
|
*/
|
|
308
|
-
|
|
328
|
+
detail?: Array<ValidationError>;
|
|
329
|
+
};
|
|
330
|
+
/**
|
|
331
|
+
* HealthComponents
|
|
332
|
+
*
|
|
333
|
+
* Component-level readiness details for GET /health.
|
|
334
|
+
*/
|
|
335
|
+
export type HealthComponents = {
|
|
309
336
|
/**
|
|
310
|
-
*
|
|
337
|
+
* Artifact Store
|
|
311
338
|
*/
|
|
312
|
-
|
|
339
|
+
artifact_store: 'local' | 'IPFS';
|
|
313
340
|
/**
|
|
314
|
-
*
|
|
341
|
+
* Database
|
|
315
342
|
*/
|
|
316
|
-
|
|
317
|
-
purl: string;
|
|
318
|
-
version: string;
|
|
319
|
-
release_date?: string;
|
|
320
|
-
}> | null;
|
|
321
|
-
parent_project: ProjectSummary | null;
|
|
343
|
+
database: 'ready' | 'not-configured';
|
|
322
344
|
/**
|
|
323
|
-
*
|
|
345
|
+
* Schema Version
|
|
324
346
|
*/
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
347
|
+
schema_version: string | null;
|
|
348
|
+
};
|
|
349
|
+
/**
|
|
350
|
+
* HealthResponse
|
|
351
|
+
*
|
|
352
|
+
* Response body for GET /health.
|
|
353
|
+
*/
|
|
354
|
+
export type HealthResponse = {
|
|
328
355
|
/**
|
|
329
|
-
*
|
|
356
|
+
* Status
|
|
330
357
|
*/
|
|
331
|
-
|
|
358
|
+
status: 'live' | 'ready';
|
|
332
359
|
/**
|
|
333
|
-
*
|
|
360
|
+
* Version
|
|
334
361
|
*/
|
|
335
|
-
|
|
362
|
+
version: string;
|
|
363
|
+
components: HealthComponents;
|
|
336
364
|
};
|
|
337
365
|
/**
|
|
338
|
-
*
|
|
366
|
+
* MaintenanceProfileResponse
|
|
339
367
|
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
* Provided as part of the repo detail response so the frontend can show
|
|
343
|
-
* "depends on N repos + M external" without fetching the full edge list.
|
|
368
|
+
* Stored maintenance profile for one repo, as materialized.
|
|
344
369
|
*/
|
|
345
|
-
export type
|
|
370
|
+
export type MaintenanceProfileResponse = {
|
|
346
371
|
/**
|
|
347
|
-
*
|
|
372
|
+
* Schema Version
|
|
348
373
|
*/
|
|
349
|
-
|
|
374
|
+
schema_version: number;
|
|
350
375
|
/**
|
|
351
|
-
*
|
|
376
|
+
* As Of
|
|
352
377
|
*/
|
|
353
|
-
|
|
378
|
+
as_of: string;
|
|
379
|
+
/**
|
|
380
|
+
* Window Days
|
|
381
|
+
*/
|
|
382
|
+
window_days: number;
|
|
383
|
+
/**
|
|
384
|
+
* Response Interval Days
|
|
385
|
+
*/
|
|
386
|
+
response_interval_days: number;
|
|
387
|
+
/**
|
|
388
|
+
* Eligible Population
|
|
389
|
+
*/
|
|
390
|
+
eligible_population: number;
|
|
391
|
+
/**
|
|
392
|
+
* Signals
|
|
393
|
+
*/
|
|
394
|
+
signals: {
|
|
395
|
+
[key: string]: {
|
|
396
|
+
[key: string]: unknown;
|
|
397
|
+
};
|
|
398
|
+
};
|
|
354
399
|
};
|
|
355
400
|
/**
|
|
356
|
-
*
|
|
401
|
+
* MetadataResponse
|
|
357
402
|
*
|
|
358
|
-
*
|
|
403
|
+
* Ecosystem-wide summary statistics returned by ``GET /metadata``.
|
|
359
404
|
*/
|
|
360
|
-
export type
|
|
405
|
+
export type MetadataResponse = {
|
|
361
406
|
/**
|
|
362
|
-
*
|
|
407
|
+
* Total Projects
|
|
363
408
|
*/
|
|
364
|
-
|
|
409
|
+
total_projects: number;
|
|
365
410
|
/**
|
|
366
|
-
*
|
|
411
|
+
* Active Projects
|
|
367
412
|
*/
|
|
368
|
-
|
|
413
|
+
active_projects: number;
|
|
369
414
|
/**
|
|
370
|
-
*
|
|
415
|
+
* Total Repos
|
|
371
416
|
*/
|
|
372
|
-
|
|
417
|
+
total_repos: number;
|
|
418
|
+
/**
|
|
419
|
+
* Active Repos 90D
|
|
420
|
+
*/
|
|
421
|
+
active_repos_90d: number;
|
|
422
|
+
/**
|
|
423
|
+
* Total External Repos
|
|
424
|
+
*/
|
|
425
|
+
total_external_repos: number;
|
|
426
|
+
/**
|
|
427
|
+
* Total Dependency Edges
|
|
428
|
+
*/
|
|
429
|
+
total_dependency_edges: number;
|
|
430
|
+
/**
|
|
431
|
+
* Total Contributor Edges
|
|
432
|
+
*/
|
|
433
|
+
total_contributor_edges: number;
|
|
434
|
+
/**
|
|
435
|
+
* Active Contributors 30D
|
|
436
|
+
*/
|
|
437
|
+
active_contributors_30d: number;
|
|
438
|
+
/**
|
|
439
|
+
* Active Contributors 90D
|
|
440
|
+
*/
|
|
441
|
+
active_contributors_90d: number;
|
|
442
|
+
/**
|
|
443
|
+
* Last Updated
|
|
444
|
+
*/
|
|
445
|
+
last_updated: string | null;
|
|
373
446
|
};
|
|
374
447
|
/**
|
|
375
|
-
*
|
|
376
|
-
*
|
|
377
|
-
* Lifecycle status of a Project.
|
|
378
|
-
*
|
|
379
|
-
* Updated by the SCF Impact Survey (yearly) and higher-frequency signals;
|
|
380
|
-
* see the Activity Status Update Logic in the architecture docs.
|
|
381
|
-
*/
|
|
382
|
-
export type ActivityStatus = 'live' | 'in-dev' | 'discontinued' | 'non-responsive';
|
|
383
|
-
/**
|
|
384
|
-
* ProjectType
|
|
385
|
-
*
|
|
386
|
-
* Classification of a Project within the PG Atlas universe.
|
|
387
|
-
*/
|
|
388
|
-
export type ProjectType = 'public-good' | 'scf-project';
|
|
389
|
-
/**
|
|
390
|
-
* ProjectSummary
|
|
391
|
-
*
|
|
392
|
-
* Compact project representation used in list endpoints and as an embedded
|
|
393
|
-
* reference in repo detail responses.
|
|
448
|
+
* PaginatedResponse[ContributorSummary]
|
|
394
449
|
*/
|
|
395
|
-
export type
|
|
450
|
+
export type PaginatedResponseContributorSummary = {
|
|
396
451
|
/**
|
|
397
|
-
*
|
|
452
|
+
* Items
|
|
398
453
|
*/
|
|
399
|
-
|
|
454
|
+
items: Array<ContributorSummary>;
|
|
400
455
|
/**
|
|
401
|
-
*
|
|
456
|
+
* Total
|
|
402
457
|
*/
|
|
403
|
-
|
|
404
|
-
project_type: ProjectType;
|
|
405
|
-
activity_status: ActivityStatus;
|
|
458
|
+
total: number;
|
|
406
459
|
/**
|
|
407
|
-
*
|
|
460
|
+
* Limit
|
|
408
461
|
*/
|
|
409
|
-
|
|
462
|
+
limit: number;
|
|
410
463
|
/**
|
|
411
|
-
*
|
|
464
|
+
* Offset
|
|
412
465
|
*/
|
|
413
|
-
|
|
466
|
+
offset: number;
|
|
467
|
+
};
|
|
468
|
+
/**
|
|
469
|
+
* PaginatedResponse[GitLogArtifactSummary]
|
|
470
|
+
*/
|
|
471
|
+
export type PaginatedResponseGitLogArtifactSummary = {
|
|
414
472
|
/**
|
|
415
|
-
*
|
|
473
|
+
* Items
|
|
416
474
|
*/
|
|
417
|
-
|
|
475
|
+
items: Array<GitLogArtifactSummary>;
|
|
418
476
|
/**
|
|
419
|
-
*
|
|
477
|
+
* Total
|
|
420
478
|
*/
|
|
421
|
-
|
|
479
|
+
total: number;
|
|
422
480
|
/**
|
|
423
|
-
*
|
|
481
|
+
* Limit
|
|
424
482
|
*/
|
|
425
|
-
|
|
483
|
+
limit: number;
|
|
426
484
|
/**
|
|
427
|
-
*
|
|
485
|
+
* Offset
|
|
428
486
|
*/
|
|
429
|
-
|
|
487
|
+
offset: number;
|
|
430
488
|
};
|
|
431
489
|
/**
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
* A single dependency or reverse-dependency edge from a repo.
|
|
435
|
-
*
|
|
436
|
-
* ``vertex_type`` tells the frontend whether the target is an in-ecosystem
|
|
437
|
-
* ``Repo`` or an ``ExternalRepo``.
|
|
490
|
+
* PaginatedResponse[GithubDependentObservationItem]
|
|
438
491
|
*/
|
|
439
|
-
export type
|
|
492
|
+
export type PaginatedResponseGithubDependentObservationItem = {
|
|
440
493
|
/**
|
|
441
|
-
*
|
|
494
|
+
* Items
|
|
442
495
|
*/
|
|
443
|
-
|
|
496
|
+
items: Array<GithubDependentObservationItem>;
|
|
444
497
|
/**
|
|
445
|
-
*
|
|
498
|
+
* Total
|
|
446
499
|
*/
|
|
447
|
-
|
|
448
|
-
vertex_type: RepoVertexType;
|
|
500
|
+
total: number;
|
|
449
501
|
/**
|
|
450
|
-
*
|
|
502
|
+
* Limit
|
|
451
503
|
*/
|
|
452
|
-
|
|
453
|
-
|
|
504
|
+
limit: number;
|
|
505
|
+
/**
|
|
506
|
+
* Offset
|
|
507
|
+
*/
|
|
508
|
+
offset: number;
|
|
454
509
|
};
|
|
455
510
|
/**
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
* How firmly an edge was established.
|
|
459
|
-
*/
|
|
460
|
-
export type EdgeConfidence = 'verified-sbom' | 'inferred-shadow';
|
|
461
|
-
/**
|
|
462
|
-
* RepoContributorSummary
|
|
463
|
-
*
|
|
464
|
-
* Contributor summary with commit counts for one repo.
|
|
511
|
+
* PaginatedResponse[ProjectContributorSummary]
|
|
465
512
|
*/
|
|
466
|
-
export type
|
|
513
|
+
export type PaginatedResponseProjectContributorSummary = {
|
|
467
514
|
/**
|
|
468
|
-
*
|
|
515
|
+
* Items
|
|
469
516
|
*/
|
|
470
|
-
|
|
517
|
+
items: Array<ProjectContributorSummary>;
|
|
471
518
|
/**
|
|
472
|
-
*
|
|
519
|
+
* Total
|
|
473
520
|
*/
|
|
474
|
-
|
|
521
|
+
total: number;
|
|
475
522
|
/**
|
|
476
|
-
*
|
|
523
|
+
* Limit
|
|
477
524
|
*/
|
|
478
|
-
|
|
525
|
+
limit: number;
|
|
479
526
|
/**
|
|
480
|
-
*
|
|
527
|
+
* Offset
|
|
481
528
|
*/
|
|
482
|
-
|
|
529
|
+
offset: number;
|
|
530
|
+
};
|
|
531
|
+
/**
|
|
532
|
+
* PaginatedResponse[ProjectSummary]
|
|
533
|
+
*/
|
|
534
|
+
export type PaginatedResponseProjectSummary = {
|
|
483
535
|
/**
|
|
484
|
-
*
|
|
536
|
+
* Items
|
|
485
537
|
*/
|
|
486
|
-
|
|
538
|
+
items: Array<ProjectSummary>;
|
|
487
539
|
/**
|
|
488
|
-
*
|
|
540
|
+
* Total
|
|
489
541
|
*/
|
|
490
|
-
|
|
542
|
+
total: number;
|
|
543
|
+
/**
|
|
544
|
+
* Limit
|
|
545
|
+
*/
|
|
546
|
+
limit: number;
|
|
547
|
+
/**
|
|
548
|
+
* Offset
|
|
549
|
+
*/
|
|
550
|
+
offset: number;
|
|
491
551
|
};
|
|
492
552
|
/**
|
|
493
|
-
*
|
|
494
|
-
*
|
|
495
|
-
* Validates and normalises the ``project_metadata`` JSONB column on ``Project``.
|
|
496
|
-
*
|
|
497
|
-
* The single write path (``_build_project_metadata`` in the OpenGrants crawler)
|
|
498
|
-
* guarantees consistent key names and types. ``extra = "allow"`` ensures that
|
|
499
|
-
* any future keys added by the crawler pass through without breaking the API.
|
|
500
|
-
* Future keys must still be added in this model for clarity.
|
|
553
|
+
* PaginatedResponse[RepoContributorSummary]
|
|
501
554
|
*/
|
|
502
|
-
export type
|
|
555
|
+
export type PaginatedResponseRepoContributorSummary = {
|
|
503
556
|
/**
|
|
504
|
-
*
|
|
557
|
+
* Items
|
|
505
558
|
*/
|
|
506
|
-
|
|
559
|
+
items: Array<RepoContributorSummary>;
|
|
507
560
|
/**
|
|
508
|
-
*
|
|
561
|
+
* Total
|
|
509
562
|
*/
|
|
510
|
-
|
|
563
|
+
total: number;
|
|
511
564
|
/**
|
|
512
|
-
*
|
|
565
|
+
* Limit
|
|
513
566
|
*/
|
|
514
|
-
|
|
567
|
+
limit: number;
|
|
515
568
|
/**
|
|
516
|
-
*
|
|
569
|
+
* Offset
|
|
517
570
|
*/
|
|
518
|
-
|
|
571
|
+
offset: number;
|
|
572
|
+
};
|
|
573
|
+
/**
|
|
574
|
+
* PaginatedResponse[RepoSummary]
|
|
575
|
+
*/
|
|
576
|
+
export type PaginatedResponseRepoSummary = {
|
|
519
577
|
/**
|
|
520
|
-
*
|
|
578
|
+
* Items
|
|
521
579
|
*/
|
|
522
|
-
|
|
580
|
+
items: Array<RepoSummary>;
|
|
523
581
|
/**
|
|
524
|
-
*
|
|
582
|
+
* Total
|
|
525
583
|
*/
|
|
526
|
-
|
|
584
|
+
total: number;
|
|
527
585
|
/**
|
|
528
|
-
*
|
|
586
|
+
* Limit
|
|
529
587
|
*/
|
|
530
|
-
|
|
588
|
+
limit: number;
|
|
531
589
|
/**
|
|
532
|
-
*
|
|
590
|
+
* Offset
|
|
533
591
|
*/
|
|
534
|
-
|
|
592
|
+
offset: number;
|
|
593
|
+
};
|
|
594
|
+
/**
|
|
595
|
+
* ProjectContributorSummary
|
|
596
|
+
*
|
|
597
|
+
* Contributor summary aggregated across all repos in a project.
|
|
598
|
+
*/
|
|
599
|
+
export type ProjectContributorSummary = {
|
|
535
600
|
/**
|
|
536
|
-
*
|
|
601
|
+
* Id
|
|
537
602
|
*/
|
|
538
|
-
|
|
603
|
+
id: number;
|
|
539
604
|
/**
|
|
540
|
-
*
|
|
605
|
+
* Name
|
|
541
606
|
*/
|
|
542
|
-
|
|
607
|
+
name: string;
|
|
543
608
|
/**
|
|
544
|
-
*
|
|
609
|
+
* Email Hash
|
|
545
610
|
*/
|
|
546
|
-
|
|
547
|
-
[key: string]: unknown;
|
|
548
|
-
}> | null;
|
|
611
|
+
email_hash: string;
|
|
549
612
|
/**
|
|
550
|
-
*
|
|
613
|
+
* Total Commits In Project
|
|
551
614
|
*/
|
|
552
|
-
|
|
615
|
+
total_commits_in_project: number;
|
|
616
|
+
};
|
|
617
|
+
/**
|
|
618
|
+
* ProjectDependency
|
|
619
|
+
*
|
|
620
|
+
* A collapsed project-level dependency: aggregates repo-level edges
|
|
621
|
+
* between two projects into a single summary.
|
|
622
|
+
*/
|
|
623
|
+
export type ProjectDependency = {
|
|
624
|
+
project: ProjectSummary;
|
|
553
625
|
/**
|
|
554
|
-
*
|
|
626
|
+
* Edge Count
|
|
555
627
|
*/
|
|
556
|
-
|
|
557
|
-
[key: string]: unknown;
|
|
628
|
+
edge_count: number;
|
|
558
629
|
};
|
|
559
630
|
/**
|
|
560
631
|
* ProjectDetailResponse
|
|
@@ -613,337 +684,372 @@ export type ProjectDetailResponse = {
|
|
|
613
684
|
metadata: ProjectMetadata;
|
|
614
685
|
};
|
|
615
686
|
/**
|
|
616
|
-
*
|
|
687
|
+
* ProjectMetadata
|
|
617
688
|
*
|
|
618
|
-
*
|
|
619
|
-
*
|
|
689
|
+
* Validates and normalises the ``project_metadata`` JSONB column on ``Project``.
|
|
690
|
+
*
|
|
691
|
+
* The single write path (``_build_project_metadata`` in the OpenGrants crawler)
|
|
692
|
+
* guarantees consistent key names and types. ``extra = "allow"`` ensures that
|
|
693
|
+
* any future keys added by the crawler pass through without breaking the API.
|
|
694
|
+
* Future keys must still be added in this model for clarity.
|
|
620
695
|
*/
|
|
621
|
-
export type
|
|
622
|
-
project: ProjectSummary;
|
|
696
|
+
export type ProjectMetadata = {
|
|
623
697
|
/**
|
|
624
|
-
*
|
|
698
|
+
* Scf Submissions
|
|
625
699
|
*/
|
|
626
|
-
|
|
627
|
-
};
|
|
628
|
-
/**
|
|
629
|
-
* ProjectContributorSummary
|
|
630
|
-
*
|
|
631
|
-
* Contributor summary aggregated across all repos in a project.
|
|
632
|
-
*/
|
|
633
|
-
export type ProjectContributorSummary = {
|
|
700
|
+
scf_submissions?: Array<ScfSubmission>;
|
|
634
701
|
/**
|
|
635
|
-
*
|
|
702
|
+
* Description
|
|
636
703
|
*/
|
|
637
|
-
|
|
704
|
+
description?: string | null;
|
|
638
705
|
/**
|
|
639
|
-
*
|
|
706
|
+
* Technical Architecture
|
|
640
707
|
*/
|
|
641
|
-
|
|
708
|
+
technical_architecture?: string | null;
|
|
642
709
|
/**
|
|
643
|
-
*
|
|
710
|
+
* Scf Tranche Completion
|
|
644
711
|
*/
|
|
645
|
-
|
|
712
|
+
scf_tranche_completion?: string | null;
|
|
646
713
|
/**
|
|
647
|
-
*
|
|
714
|
+
* Website
|
|
648
715
|
*/
|
|
649
|
-
|
|
650
|
-
};
|
|
651
|
-
/**
|
|
652
|
-
* PaginatedResponse[RepoSummary]
|
|
653
|
-
*/
|
|
654
|
-
export type PaginatedResponseRepoSummary = {
|
|
716
|
+
website?: string | null;
|
|
655
717
|
/**
|
|
656
|
-
*
|
|
718
|
+
* X Profile
|
|
657
719
|
*/
|
|
658
|
-
|
|
720
|
+
x_profile?: string | null;
|
|
659
721
|
/**
|
|
660
|
-
* Total
|
|
722
|
+
* Total Awarded Usd
|
|
661
723
|
*/
|
|
662
|
-
|
|
724
|
+
total_awarded_usd?: number | number | null;
|
|
663
725
|
/**
|
|
664
|
-
*
|
|
726
|
+
* Total Paid Usd
|
|
665
727
|
*/
|
|
666
|
-
|
|
728
|
+
total_paid_usd?: number | number | null;
|
|
667
729
|
/**
|
|
668
|
-
*
|
|
730
|
+
* Awarded Submissions Count
|
|
669
731
|
*/
|
|
670
|
-
|
|
732
|
+
awarded_submissions_count?: number | null;
|
|
733
|
+
/**
|
|
734
|
+
* Open Source
|
|
735
|
+
*/
|
|
736
|
+
open_source?: boolean | null;
|
|
737
|
+
/**
|
|
738
|
+
* Socials
|
|
739
|
+
*/
|
|
740
|
+
socials?: Array<{
|
|
741
|
+
[key: string]: unknown;
|
|
742
|
+
}> | null;
|
|
743
|
+
/**
|
|
744
|
+
* Analytics
|
|
745
|
+
*/
|
|
746
|
+
analytics?: unknown | null;
|
|
747
|
+
/**
|
|
748
|
+
* Regions Of Operation
|
|
749
|
+
*/
|
|
750
|
+
regions_of_operation?: unknown | null;
|
|
751
|
+
[key: string]: unknown;
|
|
671
752
|
};
|
|
672
753
|
/**
|
|
673
|
-
*
|
|
754
|
+
* ProjectSummary
|
|
755
|
+
*
|
|
756
|
+
* Compact project representation used in list endpoints and as an embedded
|
|
757
|
+
* reference in repo detail responses.
|
|
674
758
|
*/
|
|
675
|
-
export type
|
|
759
|
+
export type ProjectSummary = {
|
|
676
760
|
/**
|
|
677
|
-
*
|
|
761
|
+
* Canonical Id
|
|
678
762
|
*/
|
|
679
|
-
|
|
763
|
+
canonical_id: string;
|
|
764
|
+
/**
|
|
765
|
+
* Display Name
|
|
766
|
+
*/
|
|
767
|
+
display_name: string;
|
|
768
|
+
project_type: ProjectType;
|
|
769
|
+
activity_status: ActivityStatus;
|
|
770
|
+
/**
|
|
771
|
+
* Category
|
|
772
|
+
*/
|
|
773
|
+
category: string | null;
|
|
774
|
+
/**
|
|
775
|
+
* Git Owner Url
|
|
776
|
+
*/
|
|
777
|
+
git_owner_url: string | null;
|
|
778
|
+
/**
|
|
779
|
+
* Pony Factor
|
|
780
|
+
*/
|
|
781
|
+
pony_factor: number | null;
|
|
680
782
|
/**
|
|
681
|
-
*
|
|
783
|
+
* Criticality Score
|
|
682
784
|
*/
|
|
683
|
-
|
|
785
|
+
criticality_score: number | null;
|
|
684
786
|
/**
|
|
685
|
-
*
|
|
787
|
+
* Adoption Score
|
|
686
788
|
*/
|
|
687
|
-
|
|
789
|
+
adoption_score: number | null;
|
|
688
790
|
/**
|
|
689
|
-
*
|
|
791
|
+
* Updated At
|
|
690
792
|
*/
|
|
691
|
-
|
|
793
|
+
updated_at: string;
|
|
692
794
|
};
|
|
693
795
|
/**
|
|
694
|
-
*
|
|
796
|
+
* ProjectType
|
|
797
|
+
*
|
|
798
|
+
* Classification of a Project within the PG Atlas universe.
|
|
695
799
|
*/
|
|
696
|
-
export type
|
|
800
|
+
export type ProjectType = 'public-good' | 'scf-project';
|
|
801
|
+
/**
|
|
802
|
+
* RepoContributorSummary
|
|
803
|
+
*
|
|
804
|
+
* Contributor summary with commit counts for one repo.
|
|
805
|
+
*/
|
|
806
|
+
export type RepoContributorSummary = {
|
|
697
807
|
/**
|
|
698
|
-
*
|
|
808
|
+
* Id
|
|
699
809
|
*/
|
|
700
|
-
|
|
810
|
+
id: number;
|
|
701
811
|
/**
|
|
702
|
-
*
|
|
812
|
+
* Name
|
|
703
813
|
*/
|
|
704
|
-
|
|
814
|
+
name: string;
|
|
705
815
|
/**
|
|
706
|
-
*
|
|
816
|
+
* Email Hash
|
|
707
817
|
*/
|
|
708
|
-
|
|
818
|
+
email_hash: string;
|
|
709
819
|
/**
|
|
710
|
-
*
|
|
820
|
+
* Number Of Commits
|
|
711
821
|
*/
|
|
712
|
-
|
|
822
|
+
number_of_commits: number;
|
|
823
|
+
/**
|
|
824
|
+
* First Commit Date
|
|
825
|
+
*/
|
|
826
|
+
first_commit_date: string;
|
|
827
|
+
/**
|
|
828
|
+
* Last Commit Date
|
|
829
|
+
*/
|
|
830
|
+
last_commit_date: string;
|
|
713
831
|
};
|
|
714
832
|
/**
|
|
715
|
-
*
|
|
833
|
+
* RepoDependency
|
|
834
|
+
*
|
|
835
|
+
* A single dependency or reverse-dependency edge from a repo.
|
|
836
|
+
*
|
|
837
|
+
* ``vertex_type`` tells the frontend whether the target is an in-ecosystem
|
|
838
|
+
* ``Repo`` or an ``ExternalRepo``.
|
|
716
839
|
*/
|
|
717
|
-
export type
|
|
718
|
-
/**
|
|
719
|
-
* Items
|
|
720
|
-
*/
|
|
721
|
-
items: Array<ProjectContributorSummary>;
|
|
840
|
+
export type RepoDependency = {
|
|
722
841
|
/**
|
|
723
|
-
*
|
|
842
|
+
* Canonical Id
|
|
724
843
|
*/
|
|
725
|
-
|
|
844
|
+
canonical_id: string;
|
|
726
845
|
/**
|
|
727
|
-
*
|
|
846
|
+
* Display Name
|
|
728
847
|
*/
|
|
729
|
-
|
|
848
|
+
display_name: string;
|
|
849
|
+
vertex_type: RepoVertexType;
|
|
730
850
|
/**
|
|
731
|
-
*
|
|
851
|
+
* Version Range
|
|
732
852
|
*/
|
|
733
|
-
|
|
853
|
+
version_range: string | null;
|
|
854
|
+
confidence: EdgeConfidence;
|
|
734
855
|
};
|
|
735
856
|
/**
|
|
736
|
-
*
|
|
857
|
+
* RepoDetailResponse
|
|
858
|
+
*
|
|
859
|
+
* Full repo detail with parent project, contributors, releases, dependency counts,
|
|
860
|
+
* and active contributor stats.
|
|
737
861
|
*/
|
|
738
|
-
export type
|
|
739
|
-
/**
|
|
740
|
-
* Items
|
|
741
|
-
*/
|
|
742
|
-
items: Array<GitLogArtifactSummary>;
|
|
862
|
+
export type RepoDetailResponse = {
|
|
743
863
|
/**
|
|
744
|
-
*
|
|
864
|
+
* Canonical Id
|
|
745
865
|
*/
|
|
746
|
-
|
|
866
|
+
canonical_id: string;
|
|
747
867
|
/**
|
|
748
|
-
*
|
|
868
|
+
* Display Name
|
|
749
869
|
*/
|
|
750
|
-
|
|
870
|
+
display_name: string;
|
|
871
|
+
visibility: Visibility;
|
|
751
872
|
/**
|
|
752
|
-
*
|
|
873
|
+
* Latest Version
|
|
753
874
|
*/
|
|
754
|
-
|
|
755
|
-
};
|
|
756
|
-
/**
|
|
757
|
-
* GitLogArtifactSummary
|
|
758
|
-
*
|
|
759
|
-
* Compact gitlog artifact audit record for list endpoints.
|
|
760
|
-
*/
|
|
761
|
-
export type GitLogArtifactSummary = {
|
|
875
|
+
latest_version: string;
|
|
762
876
|
/**
|
|
763
|
-
*
|
|
877
|
+
* Latest Commit Date
|
|
764
878
|
*/
|
|
765
|
-
|
|
879
|
+
latest_commit_date: string | null;
|
|
766
880
|
/**
|
|
767
|
-
* Repo
|
|
881
|
+
* Repo Url
|
|
768
882
|
*/
|
|
769
|
-
|
|
883
|
+
repo_url: string | null;
|
|
770
884
|
/**
|
|
771
|
-
*
|
|
885
|
+
* Project Id
|
|
772
886
|
*/
|
|
773
|
-
|
|
887
|
+
project_id: number | null;
|
|
774
888
|
/**
|
|
775
|
-
*
|
|
889
|
+
* Pony Factor
|
|
776
890
|
*/
|
|
777
|
-
|
|
891
|
+
pony_factor: number | null;
|
|
778
892
|
/**
|
|
779
|
-
*
|
|
893
|
+
* Criticality Score
|
|
780
894
|
*/
|
|
781
|
-
|
|
782
|
-
status: SubmissionStatus;
|
|
895
|
+
criticality_score: number | null;
|
|
783
896
|
/**
|
|
784
|
-
*
|
|
897
|
+
* Adoption Downloads
|
|
785
898
|
*/
|
|
786
|
-
|
|
899
|
+
adoption_downloads: number | null;
|
|
787
900
|
/**
|
|
788
|
-
*
|
|
901
|
+
* Adoption Stars
|
|
789
902
|
*/
|
|
790
|
-
|
|
903
|
+
adoption_stars: number | null;
|
|
791
904
|
/**
|
|
792
|
-
*
|
|
905
|
+
* Adoption Forks
|
|
793
906
|
*/
|
|
794
|
-
|
|
907
|
+
adoption_forks: number | null;
|
|
795
908
|
/**
|
|
796
|
-
*
|
|
909
|
+
* Updated At
|
|
797
910
|
*/
|
|
798
|
-
|
|
799
|
-
};
|
|
800
|
-
/**
|
|
801
|
-
* PaginatedResponse[ContributorSummary]
|
|
802
|
-
*/
|
|
803
|
-
export type PaginatedResponseContributorSummary = {
|
|
911
|
+
updated_at: string;
|
|
804
912
|
/**
|
|
805
|
-
*
|
|
913
|
+
* Releases
|
|
806
914
|
*/
|
|
807
|
-
|
|
915
|
+
releases: Array<{
|
|
916
|
+
purl: string;
|
|
917
|
+
version: string;
|
|
918
|
+
release_date?: string;
|
|
919
|
+
}> | null;
|
|
920
|
+
parent_project: ProjectSummary | null;
|
|
808
921
|
/**
|
|
809
|
-
*
|
|
922
|
+
* Contributors
|
|
810
923
|
*/
|
|
811
|
-
|
|
924
|
+
contributors: Array<ContributorSummary>;
|
|
925
|
+
outgoing_dep_counts: DepCounts;
|
|
926
|
+
incoming_dep_counts: DepCounts;
|
|
812
927
|
/**
|
|
813
|
-
*
|
|
928
|
+
* Active Contributors 30D
|
|
814
929
|
*/
|
|
815
|
-
|
|
930
|
+
active_contributors_30d: number;
|
|
816
931
|
/**
|
|
817
|
-
*
|
|
932
|
+
* Active Contributors 90D
|
|
818
933
|
*/
|
|
819
|
-
|
|
934
|
+
active_contributors_90d: number;
|
|
820
935
|
};
|
|
821
936
|
/**
|
|
822
|
-
*
|
|
937
|
+
* RepoSummary
|
|
823
938
|
*
|
|
824
|
-
*
|
|
939
|
+
* Compact repo representation used in list endpoints and as an embedded
|
|
940
|
+
* reference in project detail responses.
|
|
825
941
|
*/
|
|
826
|
-
export type
|
|
942
|
+
export type RepoSummary = {
|
|
827
943
|
/**
|
|
828
|
-
*
|
|
944
|
+
* Canonical Id
|
|
829
945
|
*/
|
|
830
|
-
|
|
946
|
+
canonical_id: string;
|
|
831
947
|
/**
|
|
832
|
-
*
|
|
948
|
+
* Display Name
|
|
833
949
|
*/
|
|
834
|
-
|
|
950
|
+
display_name: string;
|
|
951
|
+
visibility: Visibility;
|
|
835
952
|
/**
|
|
836
|
-
*
|
|
953
|
+
* Latest Version
|
|
837
954
|
*/
|
|
838
|
-
|
|
955
|
+
latest_version: string;
|
|
839
956
|
/**
|
|
840
|
-
*
|
|
957
|
+
* Latest Commit Date
|
|
841
958
|
*/
|
|
842
|
-
|
|
959
|
+
latest_commit_date: string | null;
|
|
843
960
|
/**
|
|
844
|
-
*
|
|
961
|
+
* Repo Url
|
|
845
962
|
*/
|
|
846
|
-
|
|
963
|
+
repo_url: string | null;
|
|
847
964
|
/**
|
|
848
|
-
*
|
|
965
|
+
* Project Id
|
|
849
966
|
*/
|
|
850
|
-
|
|
967
|
+
project_id: number | null;
|
|
851
968
|
/**
|
|
852
|
-
*
|
|
969
|
+
* Pony Factor
|
|
853
970
|
*/
|
|
854
|
-
|
|
971
|
+
pony_factor: number | null;
|
|
855
972
|
/**
|
|
856
|
-
*
|
|
973
|
+
* Criticality Score
|
|
857
974
|
*/
|
|
858
|
-
|
|
975
|
+
criticality_score: number | null;
|
|
859
976
|
/**
|
|
860
|
-
*
|
|
977
|
+
* Adoption Downloads
|
|
861
978
|
*/
|
|
862
|
-
|
|
979
|
+
adoption_downloads: number | null;
|
|
863
980
|
/**
|
|
864
|
-
*
|
|
981
|
+
* Adoption Stars
|
|
865
982
|
*/
|
|
866
|
-
|
|
867
|
-
};
|
|
868
|
-
/**
|
|
869
|
-
* HealthResponse
|
|
870
|
-
*
|
|
871
|
-
* Response body for GET /health.
|
|
872
|
-
*/
|
|
873
|
-
export type HealthResponse = {
|
|
983
|
+
adoption_stars: number | null;
|
|
874
984
|
/**
|
|
875
|
-
*
|
|
985
|
+
* Adoption Forks
|
|
876
986
|
*/
|
|
877
|
-
|
|
987
|
+
adoption_forks: number | null;
|
|
878
988
|
/**
|
|
879
|
-
*
|
|
989
|
+
* Updated At
|
|
880
990
|
*/
|
|
881
|
-
|
|
882
|
-
components: HealthComponents;
|
|
991
|
+
updated_at: string;
|
|
883
992
|
};
|
|
884
993
|
/**
|
|
885
|
-
*
|
|
994
|
+
* RepoVertexType
|
|
886
995
|
*
|
|
887
|
-
*
|
|
996
|
+
* Discriminator values for the RepoVertex joined-table-inheritance hierarchy.
|
|
888
997
|
*/
|
|
889
|
-
export type
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
998
|
+
export type RepoVertexType = 'repo' | 'external-repo' | 'redirect';
|
|
999
|
+
/**
|
|
1000
|
+
* SbomAcceptedResponse
|
|
1001
|
+
*
|
|
1002
|
+
* Response body returned on successful SBOM submission (202 Accepted).
|
|
1003
|
+
*/
|
|
1004
|
+
export type SbomAcceptedResponse = {
|
|
894
1005
|
/**
|
|
895
|
-
*
|
|
1006
|
+
* Message
|
|
896
1007
|
*/
|
|
897
|
-
|
|
1008
|
+
message: string;
|
|
898
1009
|
/**
|
|
899
|
-
*
|
|
1010
|
+
* Repository
|
|
900
1011
|
*/
|
|
901
|
-
|
|
902
|
-
};
|
|
903
|
-
/**
|
|
904
|
-
* HTTPValidationError
|
|
905
|
-
*/
|
|
906
|
-
export type HttpValidationError = {
|
|
1012
|
+
repository: string;
|
|
907
1013
|
/**
|
|
908
|
-
*
|
|
1014
|
+
* Package Count
|
|
909
1015
|
*/
|
|
910
|
-
|
|
1016
|
+
package_count: number;
|
|
911
1017
|
};
|
|
912
1018
|
/**
|
|
913
|
-
*
|
|
1019
|
+
* SbomSubmissionDetailResponse
|
|
914
1020
|
*
|
|
915
|
-
*
|
|
1021
|
+
* Extended SBOM submission record with the raw artifact content.
|
|
1022
|
+
*
|
|
1023
|
+
* Returned by the detail endpoint. ``raw_artifact`` contains the full JSON
|
|
1024
|
+
* text of the stored SBOM, or ``None`` if the artifact file is missing from
|
|
1025
|
+
* the store.
|
|
916
1026
|
*/
|
|
917
|
-
export type
|
|
1027
|
+
export type SbomSubmissionDetailResponse = {
|
|
918
1028
|
/**
|
|
919
1029
|
* Id
|
|
920
1030
|
*/
|
|
921
1031
|
id: number;
|
|
922
1032
|
/**
|
|
923
|
-
*
|
|
1033
|
+
* Repository Claim
|
|
924
1034
|
*/
|
|
925
|
-
|
|
1035
|
+
repository_claim: string;
|
|
926
1036
|
/**
|
|
927
|
-
*
|
|
1037
|
+
* Actor Claim
|
|
928
1038
|
*/
|
|
929
|
-
|
|
1039
|
+
actor_claim: string;
|
|
930
1040
|
/**
|
|
931
|
-
*
|
|
1041
|
+
* Sbom Content Hash
|
|
932
1042
|
*/
|
|
933
|
-
|
|
1043
|
+
sbom_content_hash: string;
|
|
934
1044
|
/**
|
|
935
1045
|
* Artifact Path
|
|
936
1046
|
*/
|
|
937
|
-
artifact_path: string
|
|
1047
|
+
artifact_path: string;
|
|
938
1048
|
status: SubmissionStatus;
|
|
939
1049
|
/**
|
|
940
1050
|
* Error Detail
|
|
941
1051
|
*/
|
|
942
1052
|
error_detail: string | null;
|
|
943
|
-
/**
|
|
944
|
-
* Since Months
|
|
945
|
-
*/
|
|
946
|
-
since_months: number;
|
|
947
1053
|
/**
|
|
948
1054
|
* Submitted At
|
|
949
1055
|
*/
|
|
@@ -958,75 +1064,128 @@ export type GitLogArtifactDetailResponse = {
|
|
|
958
1064
|
raw_artifact?: string | null;
|
|
959
1065
|
};
|
|
960
1066
|
/**
|
|
961
|
-
*
|
|
1067
|
+
* SbomSubmissionListResponse
|
|
962
1068
|
*
|
|
963
|
-
*
|
|
1069
|
+
* Paginated list of SBOM submission records.
|
|
1070
|
+
*
|
|
1071
|
+
* Returned by the list endpoint with ``total`` reflecting the count after
|
|
1072
|
+
* any ``repository`` filter has been applied.
|
|
964
1073
|
*/
|
|
965
|
-
export type
|
|
1074
|
+
export type SbomSubmissionListResponse = {
|
|
1075
|
+
/**
|
|
1076
|
+
* Items
|
|
1077
|
+
*/
|
|
1078
|
+
items: Array<SbomSubmissionResponse>;
|
|
1079
|
+
/**
|
|
1080
|
+
* Total
|
|
1081
|
+
*/
|
|
1082
|
+
total: number;
|
|
1083
|
+
/**
|
|
1084
|
+
* Limit
|
|
1085
|
+
*/
|
|
1086
|
+
limit: number;
|
|
1087
|
+
/**
|
|
1088
|
+
* Offset
|
|
1089
|
+
*/
|
|
1090
|
+
offset: number;
|
|
1091
|
+
};
|
|
1092
|
+
/**
|
|
1093
|
+
* SbomSubmissionResponse
|
|
1094
|
+
*
|
|
1095
|
+
* Full SBOM submission record.
|
|
1096
|
+
*
|
|
1097
|
+
* Serialised from the ``SbomSubmission`` ORM model. The ``sbom_content_hash``
|
|
1098
|
+
* field is the SHA-256 hex digest of the raw submitted payload.
|
|
1099
|
+
*/
|
|
1100
|
+
export type SbomSubmissionResponse = {
|
|
966
1101
|
/**
|
|
967
1102
|
* Id
|
|
968
1103
|
*/
|
|
969
1104
|
id: number;
|
|
970
1105
|
/**
|
|
971
|
-
*
|
|
1106
|
+
* Repository Claim
|
|
972
1107
|
*/
|
|
973
|
-
|
|
1108
|
+
repository_claim: string;
|
|
974
1109
|
/**
|
|
975
|
-
*
|
|
1110
|
+
* Actor Claim
|
|
976
1111
|
*/
|
|
977
|
-
|
|
1112
|
+
actor_claim: string;
|
|
978
1113
|
/**
|
|
979
|
-
*
|
|
1114
|
+
* Sbom Content Hash
|
|
980
1115
|
*/
|
|
981
|
-
|
|
1116
|
+
sbom_content_hash: string;
|
|
982
1117
|
/**
|
|
983
|
-
*
|
|
1118
|
+
* Artifact Path
|
|
984
1119
|
*/
|
|
985
|
-
|
|
1120
|
+
artifact_path: string;
|
|
1121
|
+
status: SubmissionStatus;
|
|
986
1122
|
/**
|
|
987
|
-
*
|
|
1123
|
+
* Error Detail
|
|
988
1124
|
*/
|
|
989
|
-
|
|
1125
|
+
error_detail: string | null;
|
|
990
1126
|
/**
|
|
991
|
-
*
|
|
1127
|
+
* Submitted At
|
|
992
1128
|
*/
|
|
993
|
-
|
|
1129
|
+
submitted_at: string;
|
|
994
1130
|
/**
|
|
995
|
-
*
|
|
1131
|
+
* Processed At
|
|
996
1132
|
*/
|
|
997
|
-
|
|
1133
|
+
processed_at: string | null;
|
|
998
1134
|
};
|
|
999
1135
|
/**
|
|
1000
|
-
*
|
|
1136
|
+
* ScfSubmission
|
|
1001
1137
|
*
|
|
1002
|
-
* A single
|
|
1138
|
+
* A single SCF funding round submission.
|
|
1003
1139
|
*/
|
|
1004
|
-
export type
|
|
1140
|
+
export type ScfSubmission = {
|
|
1005
1141
|
/**
|
|
1006
|
-
*
|
|
1142
|
+
* Round
|
|
1007
1143
|
*/
|
|
1008
|
-
|
|
1144
|
+
round: string;
|
|
1009
1145
|
/**
|
|
1010
|
-
*
|
|
1146
|
+
* Title
|
|
1011
1147
|
*/
|
|
1012
|
-
|
|
1148
|
+
title: string;
|
|
1149
|
+
};
|
|
1150
|
+
/**
|
|
1151
|
+
* SubmissionStatus
|
|
1152
|
+
*
|
|
1153
|
+
* Processing state of an artifact-linked audit record.
|
|
1154
|
+
*/
|
|
1155
|
+
export type SubmissionStatus = 'pending' | 'processed' | 'failed';
|
|
1156
|
+
/**
|
|
1157
|
+
* ValidationError
|
|
1158
|
+
*/
|
|
1159
|
+
export type ValidationError = {
|
|
1013
1160
|
/**
|
|
1014
|
-
*
|
|
1161
|
+
* Location
|
|
1015
1162
|
*/
|
|
1016
|
-
|
|
1163
|
+
loc: Array<string | number>;
|
|
1017
1164
|
/**
|
|
1018
|
-
*
|
|
1165
|
+
* Message
|
|
1019
1166
|
*/
|
|
1020
|
-
|
|
1167
|
+
msg: string;
|
|
1021
1168
|
/**
|
|
1022
|
-
*
|
|
1169
|
+
* Error Type
|
|
1023
1170
|
*/
|
|
1024
|
-
|
|
1171
|
+
type: string;
|
|
1025
1172
|
/**
|
|
1026
|
-
*
|
|
1173
|
+
* Input
|
|
1027
1174
|
*/
|
|
1028
|
-
|
|
1175
|
+
input?: unknown;
|
|
1176
|
+
/**
|
|
1177
|
+
* Context
|
|
1178
|
+
*/
|
|
1179
|
+
ctx?: {
|
|
1180
|
+
[key: string]: unknown;
|
|
1181
|
+
};
|
|
1029
1182
|
};
|
|
1183
|
+
/**
|
|
1184
|
+
* Visibility
|
|
1185
|
+
*
|
|
1186
|
+
* Whether a Repo is publicly accessible (affects data collection scope).
|
|
1187
|
+
*/
|
|
1188
|
+
export type Visibility = 'public' | 'private';
|
|
1030
1189
|
export type HealthData = {
|
|
1031
1190
|
body?: never;
|
|
1032
1191
|
path?: never;
|
|
@@ -1200,31 +1359,6 @@ export type ListProjectsResponses = {
|
|
|
1200
1359
|
200: PaginatedResponseProjectSummary;
|
|
1201
1360
|
};
|
|
1202
1361
|
export type ListProjectsResponse = ListProjectsResponses[keyof ListProjectsResponses];
|
|
1203
|
-
export type GetProjectData = {
|
|
1204
|
-
body?: never;
|
|
1205
|
-
path: {
|
|
1206
|
-
/**
|
|
1207
|
-
* Canonical Id
|
|
1208
|
-
*/
|
|
1209
|
-
canonical_id: string;
|
|
1210
|
-
};
|
|
1211
|
-
query?: never;
|
|
1212
|
-
url: '/projects/{canonical_id}';
|
|
1213
|
-
};
|
|
1214
|
-
export type GetProjectErrors = {
|
|
1215
|
-
/**
|
|
1216
|
-
* Validation Error
|
|
1217
|
-
*/
|
|
1218
|
-
422: HttpValidationError;
|
|
1219
|
-
};
|
|
1220
|
-
export type GetProjectError = GetProjectErrors[keyof GetProjectErrors];
|
|
1221
|
-
export type GetProjectResponses = {
|
|
1222
|
-
/**
|
|
1223
|
-
* Successful Response
|
|
1224
|
-
*/
|
|
1225
|
-
200: ProjectDetailResponse;
|
|
1226
|
-
};
|
|
1227
|
-
export type GetProjectResponse = GetProjectResponses[keyof GetProjectResponses];
|
|
1228
1362
|
export type GetProjectReposData = {
|
|
1229
1363
|
body?: never;
|
|
1230
1364
|
path: {
|
|
@@ -1359,6 +1493,31 @@ export type GetProjectHasDependentsResponses = {
|
|
|
1359
1493
|
200: Array<ProjectDependency>;
|
|
1360
1494
|
};
|
|
1361
1495
|
export type GetProjectHasDependentsResponse = GetProjectHasDependentsResponses[keyof GetProjectHasDependentsResponses];
|
|
1496
|
+
export type GetProjectData = {
|
|
1497
|
+
body?: never;
|
|
1498
|
+
path: {
|
|
1499
|
+
/**
|
|
1500
|
+
* Canonical Id
|
|
1501
|
+
*/
|
|
1502
|
+
canonical_id: string;
|
|
1503
|
+
};
|
|
1504
|
+
query?: never;
|
|
1505
|
+
url: '/projects/{canonical_id}';
|
|
1506
|
+
};
|
|
1507
|
+
export type GetProjectErrors = {
|
|
1508
|
+
/**
|
|
1509
|
+
* Validation Error
|
|
1510
|
+
*/
|
|
1511
|
+
422: HttpValidationError;
|
|
1512
|
+
};
|
|
1513
|
+
export type GetProjectError = GetProjectErrors[keyof GetProjectErrors];
|
|
1514
|
+
export type GetProjectResponses = {
|
|
1515
|
+
/**
|
|
1516
|
+
* Successful Response
|
|
1517
|
+
*/
|
|
1518
|
+
200: ProjectDetailResponse;
|
|
1519
|
+
};
|
|
1520
|
+
export type GetProjectResponse = GetProjectResponses[keyof GetProjectResponses];
|
|
1362
1521
|
export type ListReposData = {
|
|
1363
1522
|
body?: never;
|
|
1364
1523
|
path?: never;
|
|
@@ -1460,6 +1619,69 @@ export type GetRepoHasDependentsResponses = {
|
|
|
1460
1619
|
200: Array<RepoDependency>;
|
|
1461
1620
|
};
|
|
1462
1621
|
export type GetRepoHasDependentsResponse = GetRepoHasDependentsResponses[keyof GetRepoHasDependentsResponses];
|
|
1622
|
+
export type GetRepoGithubDependentsData = {
|
|
1623
|
+
body?: never;
|
|
1624
|
+
path: {
|
|
1625
|
+
/**
|
|
1626
|
+
* Canonical Id
|
|
1627
|
+
*/
|
|
1628
|
+
canonical_id: string;
|
|
1629
|
+
};
|
|
1630
|
+
query?: {
|
|
1631
|
+
/**
|
|
1632
|
+
* Limit
|
|
1633
|
+
*
|
|
1634
|
+
* Maximum number of items to return
|
|
1635
|
+
*/
|
|
1636
|
+
limit?: number;
|
|
1637
|
+
/**
|
|
1638
|
+
* Offset
|
|
1639
|
+
*
|
|
1640
|
+
* Number of items to skip
|
|
1641
|
+
*/
|
|
1642
|
+
offset?: number;
|
|
1643
|
+
};
|
|
1644
|
+
url: '/repos/{canonical_id}/github-dependents';
|
|
1645
|
+
};
|
|
1646
|
+
export type GetRepoGithubDependentsErrors = {
|
|
1647
|
+
/**
|
|
1648
|
+
* Validation Error
|
|
1649
|
+
*/
|
|
1650
|
+
422: HttpValidationError;
|
|
1651
|
+
};
|
|
1652
|
+
export type GetRepoGithubDependentsError = GetRepoGithubDependentsErrors[keyof GetRepoGithubDependentsErrors];
|
|
1653
|
+
export type GetRepoGithubDependentsResponses = {
|
|
1654
|
+
/**
|
|
1655
|
+
* Successful Response
|
|
1656
|
+
*/
|
|
1657
|
+
200: GithubDependentsResponse;
|
|
1658
|
+
};
|
|
1659
|
+
export type GetRepoGithubDependentsResponse = GetRepoGithubDependentsResponses[keyof GetRepoGithubDependentsResponses];
|
|
1660
|
+
export type GetRepoMaintenanceProfileData = {
|
|
1661
|
+
body?: never;
|
|
1662
|
+
path: {
|
|
1663
|
+
/**
|
|
1664
|
+
* Canonical Id
|
|
1665
|
+
*/
|
|
1666
|
+
canonical_id: string;
|
|
1667
|
+
};
|
|
1668
|
+
query?: never;
|
|
1669
|
+
url: '/repos/{canonical_id}/maintenance-profile';
|
|
1670
|
+
};
|
|
1671
|
+
export type GetRepoMaintenanceProfileErrors = {
|
|
1672
|
+
/**
|
|
1673
|
+
* Validation Error
|
|
1674
|
+
*/
|
|
1675
|
+
422: HttpValidationError;
|
|
1676
|
+
};
|
|
1677
|
+
export type GetRepoMaintenanceProfileError = GetRepoMaintenanceProfileErrors[keyof GetRepoMaintenanceProfileErrors];
|
|
1678
|
+
export type GetRepoMaintenanceProfileResponses = {
|
|
1679
|
+
/**
|
|
1680
|
+
* Successful Response
|
|
1681
|
+
*/
|
|
1682
|
+
200: MaintenanceProfileResponse;
|
|
1683
|
+
};
|
|
1684
|
+
export type GetRepoMaintenanceProfileResponse = GetRepoMaintenanceProfileResponses[keyof GetRepoMaintenanceProfileResponses];
|
|
1463
1685
|
export type GetRepoContributorsData = {
|
|
1464
1686
|
body?: never;
|
|
1465
1687
|
path: {
|
|
@@ -1596,7 +1818,7 @@ export type ListGitlogArtifactsData = {
|
|
|
1596
1818
|
/**
|
|
1597
1819
|
* Repo
|
|
1598
1820
|
*
|
|
1599
|
-
* Filter by repo canonical_id (
|
|
1821
|
+
* Filter by repo canonical_id (case-insensitive)
|
|
1600
1822
|
*/
|
|
1601
1823
|
repo?: string | null;
|
|
1602
1824
|
/**
|