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