@pg-atlas/data-sdk 0.5.0 → 0.7.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/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/schemas.gen.d.ts +226 -2
- package/dist/generated/schemas.gen.js +295 -3
- package/dist/generated/sdk.gen.d.ts +21 -11
- package/dist/generated/sdk.gen.js +20 -10
- package/dist/generated/types.gen.d.ts +204 -2
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { getContributor, getGitlogArtifact, getMetadata, getProject, getProjectContributors, getProjectDependsOn, getProjectHasDependents, getProjectRepos, getRepo, getRepoContributors, getRepoDependsOn, getRepoHasDependents, getSbomSubmission, health, ingestSbom, listContributors, listGitlogArtifacts, listProjects, listRepos, listSbomSubmissions, type Options } from './sdk.gen';
|
|
2
|
-
export type { ActivityStatus, ClientOptions, ContributionEntry, ContributorDetailResponse, ContributorSummary, DepCounts, EdgeConfidence, GetContributorData, GetContributorError, GetContributorErrors, GetContributorResponse, GetContributorResponses, GetGitlogArtifactData, GetGitlogArtifactError, GetGitlogArtifactErrors, GetGitlogArtifactResponse, GetGitlogArtifactResponses, GetMetadataData, GetMetadataResponse, GetMetadataResponses, GetProjectContributorsData, GetProjectContributorsError, GetProjectContributorsErrors, GetProjectContributorsResponse, GetProjectContributorsResponses, GetProjectData, GetProjectDependsOnData, GetProjectDependsOnError, GetProjectDependsOnErrors, GetProjectDependsOnResponse, GetProjectDependsOnResponses, GetProjectError, GetProjectErrors, GetProjectHasDependentsData, GetProjectHasDependentsError, GetProjectHasDependentsErrors, GetProjectHasDependentsResponse, GetProjectHasDependentsResponses, GetProjectReposData, GetProjectReposError, GetProjectReposErrors, GetProjectReposResponse, GetProjectReposResponses, GetProjectResponse, GetProjectResponses, GetRepoContributorsData, GetRepoContributorsError, GetRepoContributorsErrors, GetRepoContributorsResponse, GetRepoContributorsResponses, GetRepoData, GetRepoDependsOnData, GetRepoDependsOnError, GetRepoDependsOnErrors, GetRepoDependsOnResponse, GetRepoDependsOnResponses, GetRepoError, GetRepoErrors, GetRepoHasDependentsData, GetRepoHasDependentsError, GetRepoHasDependentsErrors, GetRepoHasDependentsResponse, GetRepoHasDependentsResponses, GetRepoResponse, GetRepoResponses, GetSbomSubmissionData, GetSbomSubmissionError, GetSbomSubmissionErrors, GetSbomSubmissionResponse, GetSbomSubmissionResponses, GitLogArtifactDetailResponse, GitLogArtifactSummary, HealthData, HealthResponse, HealthResponse2, HealthResponses, HttpValidationError, IngestSbomData, IngestSbomError, IngestSbomErrors, IngestSbomResponse, IngestSbomResponses, ListContributorsData, ListContributorsError, ListContributorsErrors, ListContributorsResponse, ListContributorsResponses, ListGitlogArtifactsData, ListGitlogArtifactsError, ListGitlogArtifactsErrors, ListGitlogArtifactsResponse, ListGitlogArtifactsResponses, ListProjectsData, ListProjectsError, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListReposData, ListReposError, ListReposErrors, ListReposResponse, ListReposResponses, ListSbomSubmissionsData, ListSbomSubmissionsError, ListSbomSubmissionsErrors, ListSbomSubmissionsResponse, ListSbomSubmissionsResponses, MetadataResponse, PaginatedResponseContributorSummary, PaginatedResponseGitLogArtifactSummary, PaginatedResponseProjectContributorSummary, PaginatedResponseProjectSummary, PaginatedResponseRepoContributorSummary, PaginatedResponseRepoSummary, ProjectContributorSummary, ProjectDependency, ProjectDetailResponse, ProjectMetadata, ProjectSummary, ProjectType, RepoContributorSummary, RepoDependency, RepoDetailResponse, RepoSummary, RepoVertexType, SbomAcceptedResponse, SbomSubmissionDetailResponse, SbomSubmissionListResponse, SbomSubmissionResponse, ScfSubmission, SubmissionStatus, ValidationError, Visibility } from './types.gen';
|
|
1
|
+
export { getContributor, getGitlogArtifact, getMetadata, getProject, getProjectContributors, getProjectDependsOn, getProjectHasDependents, getProjectRepos, getRepo, getRepoContributors, getRepoDependsOn, getRepoGithubDependents, getRepoHasDependents, getSbomSubmission, health, ingestSbom, listContributors, listGitlogArtifacts, listProjects, listRepos, listSbomSubmissions, type Options } from './sdk.gen';
|
|
2
|
+
export type { ActivityStatus, ClientOptions, ContributionEntry, ContributorDetailResponse, ContributorSummary, DepCounts, EdgeConfidence, GetContributorData, GetContributorError, GetContributorErrors, GetContributorResponse, GetContributorResponses, GetGitlogArtifactData, GetGitlogArtifactError, GetGitlogArtifactErrors, GetGitlogArtifactResponse, GetGitlogArtifactResponses, GetMetadataData, GetMetadataResponse, GetMetadataResponses, GetProjectContributorsData, GetProjectContributorsError, GetProjectContributorsErrors, GetProjectContributorsResponse, GetProjectContributorsResponses, GetProjectData, GetProjectDependsOnData, GetProjectDependsOnError, GetProjectDependsOnErrors, GetProjectDependsOnResponse, GetProjectDependsOnResponses, GetProjectError, GetProjectErrors, GetProjectHasDependentsData, GetProjectHasDependentsError, GetProjectHasDependentsErrors, GetProjectHasDependentsResponse, GetProjectHasDependentsResponses, GetProjectReposData, GetProjectReposError, GetProjectReposErrors, GetProjectReposResponse, GetProjectReposResponses, GetProjectResponse, GetProjectResponses, GetRepoContributorsData, GetRepoContributorsError, GetRepoContributorsErrors, GetRepoContributorsResponse, GetRepoContributorsResponses, GetRepoData, GetRepoDependsOnData, GetRepoDependsOnError, GetRepoDependsOnErrors, GetRepoDependsOnResponse, GetRepoDependsOnResponses, GetRepoError, GetRepoErrors, GetRepoGithubDependentsData, GetRepoGithubDependentsError, GetRepoGithubDependentsErrors, GetRepoGithubDependentsResponse, GetRepoGithubDependentsResponses, GetRepoHasDependentsData, GetRepoHasDependentsError, GetRepoHasDependentsErrors, GetRepoHasDependentsResponse, GetRepoHasDependentsResponses, GetRepoResponse, GetRepoResponses, GetSbomSubmissionData, GetSbomSubmissionError, GetSbomSubmissionErrors, GetSbomSubmissionResponse, GetSbomSubmissionResponses, GithubDependentObservationItem, GithubDependentsResponse, GithubDependentsSummary, GitLogArtifactDetailResponse, GitLogArtifactSummary, HealthComponents, HealthData, HealthResponse, HealthResponse2, HealthResponses, HttpValidationError, IngestSbomData, IngestSbomError, IngestSbomErrors, IngestSbomResponse, IngestSbomResponses, ListContributorsData, ListContributorsError, ListContributorsErrors, ListContributorsResponse, ListContributorsResponses, ListGitlogArtifactsData, ListGitlogArtifactsError, ListGitlogArtifactsErrors, ListGitlogArtifactsResponse, ListGitlogArtifactsResponses, ListProjectsData, ListProjectsError, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListReposData, ListReposError, ListReposErrors, ListReposResponse, ListReposResponses, ListSbomSubmissionsData, ListSbomSubmissionsError, ListSbomSubmissionsErrors, ListSbomSubmissionsResponse, ListSbomSubmissionsResponses, MetadataResponse, PaginatedResponseContributorSummary, PaginatedResponseGithubDependentObservationItem, PaginatedResponseGitLogArtifactSummary, PaginatedResponseProjectContributorSummary, PaginatedResponseProjectSummary, PaginatedResponseRepoContributorSummary, PaginatedResponseRepoSummary, ProjectContributorSummary, ProjectDependency, ProjectDetailResponse, ProjectMetadata, ProjectSummary, ProjectType, RepoContributorSummary, RepoDependency, RepoDetailResponse, RepoSummary, RepoVertexType, SbomAcceptedResponse, SbomSubmissionDetailResponse, SbomSubmissionListResponse, SbomSubmissionResponse, ScfSubmission, SubmissionStatus, ValidationError, Visibility } from './types.gen';
|
package/dist/generated/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
-
export { getContributor, getGitlogArtifact, getMetadata, getProject, getProjectContributors, getProjectDependsOn, getProjectHasDependents, getProjectRepos, getRepo, getRepoContributors, getRepoDependsOn, getRepoHasDependents, getSbomSubmission, health, ingestSbom, listContributors, listGitlogArtifacts, listProjects, listRepos, listSbomSubmissions } from './sdk.gen';
|
|
2
|
+
export { getContributor, getGitlogArtifact, getMetadata, getProject, getProjectContributors, getProjectDependsOn, getProjectHasDependents, getProjectRepos, getRepo, getRepoContributors, getRepoDependsOn, getRepoGithubDependents, getRepoHasDependents, getSbomSubmission, health, ingestSbom, listContributors, listGitlogArtifacts, listProjects, listRepos, listSbomSubmissions } from './sdk.gen';
|
|
@@ -409,8 +409,22 @@ export declare const RepoDetailResponseSchema: {
|
|
|
409
409
|
readonly releases: {
|
|
410
410
|
readonly anyOf: readonly [{
|
|
411
411
|
readonly items: {
|
|
412
|
-
readonly
|
|
412
|
+
readonly properties: {
|
|
413
|
+
readonly purl: {
|
|
414
|
+
readonly type: "string";
|
|
415
|
+
};
|
|
416
|
+
readonly version: {
|
|
417
|
+
readonly type: "string";
|
|
418
|
+
};
|
|
419
|
+
readonly release_date: {
|
|
420
|
+
readonly type: "string";
|
|
421
|
+
readonly default: "";
|
|
422
|
+
};
|
|
423
|
+
};
|
|
413
424
|
readonly type: "object";
|
|
425
|
+
readonly required: readonly ["purl", "version"];
|
|
426
|
+
readonly title: "Release";
|
|
427
|
+
readonly description: "One normalized release record keyed by package PURL + version.";
|
|
414
428
|
};
|
|
415
429
|
readonly type: "array";
|
|
416
430
|
}, {
|
|
@@ -978,6 +992,85 @@ export declare const PaginatedResponse_ProjectContributorSummary_Schema: {
|
|
|
978
992
|
readonly required: readonly ["items", "total", "limit", "offset"];
|
|
979
993
|
readonly title: "PaginatedResponse[ProjectContributorSummary]";
|
|
980
994
|
};
|
|
995
|
+
export declare const PaginatedResponse_GithubDependentObservationItem_Schema: {
|
|
996
|
+
readonly properties: {
|
|
997
|
+
readonly items: {
|
|
998
|
+
readonly items: {
|
|
999
|
+
readonly $ref: "#/components/schemas/GithubDependentObservationItem";
|
|
1000
|
+
};
|
|
1001
|
+
readonly type: "array";
|
|
1002
|
+
readonly title: "Items";
|
|
1003
|
+
};
|
|
1004
|
+
readonly total: {
|
|
1005
|
+
readonly type: "integer";
|
|
1006
|
+
readonly title: "Total";
|
|
1007
|
+
};
|
|
1008
|
+
readonly limit: {
|
|
1009
|
+
readonly type: "integer";
|
|
1010
|
+
readonly title: "Limit";
|
|
1011
|
+
};
|
|
1012
|
+
readonly offset: {
|
|
1013
|
+
readonly type: "integer";
|
|
1014
|
+
readonly title: "Offset";
|
|
1015
|
+
};
|
|
1016
|
+
};
|
|
1017
|
+
readonly type: "object";
|
|
1018
|
+
readonly required: readonly ["items", "total", "limit", "offset"];
|
|
1019
|
+
readonly title: "PaginatedResponse[GithubDependentObservationItem]";
|
|
1020
|
+
};
|
|
1021
|
+
export declare const GithubDependentObservationItemSchema: {
|
|
1022
|
+
readonly properties: {
|
|
1023
|
+
readonly dependent_canonical_id: {
|
|
1024
|
+
readonly type: "string";
|
|
1025
|
+
readonly title: "Dependent Canonical Id";
|
|
1026
|
+
};
|
|
1027
|
+
readonly dependent_repo_url: {
|
|
1028
|
+
readonly type: "string";
|
|
1029
|
+
readonly title: "Dependent Repo Url";
|
|
1030
|
+
};
|
|
1031
|
+
readonly observed_owner: {
|
|
1032
|
+
readonly type: "string";
|
|
1033
|
+
readonly title: "Observed Owner";
|
|
1034
|
+
};
|
|
1035
|
+
readonly observed_repo_name: {
|
|
1036
|
+
readonly type: "string";
|
|
1037
|
+
readonly title: "Observed Repo Name";
|
|
1038
|
+
};
|
|
1039
|
+
readonly resolved_repo_canonical_id: {
|
|
1040
|
+
readonly anyOf: readonly [{
|
|
1041
|
+
readonly type: "string";
|
|
1042
|
+
}, {
|
|
1043
|
+
readonly type: "null";
|
|
1044
|
+
}];
|
|
1045
|
+
readonly title: "Resolved Repo Canonical Id";
|
|
1046
|
+
};
|
|
1047
|
+
readonly package_ids: {
|
|
1048
|
+
readonly anyOf: readonly [{
|
|
1049
|
+
readonly items: {
|
|
1050
|
+
readonly type: "string";
|
|
1051
|
+
};
|
|
1052
|
+
readonly type: "array";
|
|
1053
|
+
}, {
|
|
1054
|
+
readonly type: "null";
|
|
1055
|
+
}];
|
|
1056
|
+
readonly title: "Package Ids";
|
|
1057
|
+
};
|
|
1058
|
+
readonly first_seen_at: {
|
|
1059
|
+
readonly type: "string";
|
|
1060
|
+
readonly format: "date-time";
|
|
1061
|
+
readonly title: "First Seen At";
|
|
1062
|
+
};
|
|
1063
|
+
readonly last_seen_at: {
|
|
1064
|
+
readonly type: "string";
|
|
1065
|
+
readonly format: "date-time";
|
|
1066
|
+
readonly title: "Last Seen At";
|
|
1067
|
+
};
|
|
1068
|
+
};
|
|
1069
|
+
readonly type: "object";
|
|
1070
|
+
readonly required: readonly ["dependent_canonical_id", "dependent_repo_url", "observed_owner", "observed_repo_name", "first_seen_at", "last_seen_at"];
|
|
1071
|
+
readonly title: "GithubDependentObservationItem";
|
|
1072
|
+
readonly description: "One active GitHub dependent observation for a source repo.";
|
|
1073
|
+
};
|
|
981
1074
|
export declare const PaginatedResponse_GitLogArtifactSummary_Schema: {
|
|
982
1075
|
readonly properties: {
|
|
983
1076
|
readonly items: {
|
|
@@ -1148,18 +1241,48 @@ export declare const HealthResponseSchema: {
|
|
|
1148
1241
|
readonly properties: {
|
|
1149
1242
|
readonly status: {
|
|
1150
1243
|
readonly type: "string";
|
|
1244
|
+
readonly enum: readonly ["live", "ready"];
|
|
1151
1245
|
readonly title: "Status";
|
|
1152
1246
|
};
|
|
1153
1247
|
readonly version: {
|
|
1154
1248
|
readonly type: "string";
|
|
1155
1249
|
readonly title: "Version";
|
|
1156
1250
|
};
|
|
1251
|
+
readonly components: {
|
|
1252
|
+
readonly $ref: "#/components/schemas/HealthComponents";
|
|
1253
|
+
};
|
|
1157
1254
|
};
|
|
1158
1255
|
readonly type: "object";
|
|
1159
|
-
readonly required: readonly ["status", "version"];
|
|
1256
|
+
readonly required: readonly ["status", "version", "components"];
|
|
1160
1257
|
readonly title: "HealthResponse";
|
|
1161
1258
|
readonly description: "Response body for GET /health.";
|
|
1162
1259
|
};
|
|
1260
|
+
export declare const HealthComponentsSchema: {
|
|
1261
|
+
readonly properties: {
|
|
1262
|
+
readonly artifact_store: {
|
|
1263
|
+
readonly type: "string";
|
|
1264
|
+
readonly enum: readonly ["local", "IPFS"];
|
|
1265
|
+
readonly title: "Artifact Store";
|
|
1266
|
+
};
|
|
1267
|
+
readonly database: {
|
|
1268
|
+
readonly type: "string";
|
|
1269
|
+
readonly enum: readonly ["ready", "not-configured"];
|
|
1270
|
+
readonly title: "Database";
|
|
1271
|
+
};
|
|
1272
|
+
readonly schema_version: {
|
|
1273
|
+
readonly anyOf: readonly [{
|
|
1274
|
+
readonly type: "string";
|
|
1275
|
+
}, {
|
|
1276
|
+
readonly type: "null";
|
|
1277
|
+
}];
|
|
1278
|
+
readonly title: "Schema Version";
|
|
1279
|
+
};
|
|
1280
|
+
};
|
|
1281
|
+
readonly type: "object";
|
|
1282
|
+
readonly required: readonly ["artifact_store", "database", "schema_version"];
|
|
1283
|
+
readonly title: "HealthComponents";
|
|
1284
|
+
readonly description: "Component-level readiness details for GET /health.";
|
|
1285
|
+
};
|
|
1163
1286
|
export declare const HTTPValidationErrorSchema: {
|
|
1164
1287
|
readonly properties: {
|
|
1165
1288
|
readonly detail: {
|
|
@@ -1173,6 +1296,107 @@ export declare const HTTPValidationErrorSchema: {
|
|
|
1173
1296
|
readonly type: "object";
|
|
1174
1297
|
readonly title: "HTTPValidationError";
|
|
1175
1298
|
};
|
|
1299
|
+
export declare const GithubDependentsSummarySchema: {
|
|
1300
|
+
readonly properties: {
|
|
1301
|
+
readonly latest_attempt_at: {
|
|
1302
|
+
readonly anyOf: readonly [{
|
|
1303
|
+
readonly type: "string";
|
|
1304
|
+
readonly format: "date-time";
|
|
1305
|
+
}, {
|
|
1306
|
+
readonly type: "null";
|
|
1307
|
+
}];
|
|
1308
|
+
readonly title: "Latest Attempt At";
|
|
1309
|
+
};
|
|
1310
|
+
readonly latest_attempt_status: {
|
|
1311
|
+
readonly anyOf: readonly [{
|
|
1312
|
+
readonly type: "string";
|
|
1313
|
+
}, {
|
|
1314
|
+
readonly type: "null";
|
|
1315
|
+
}];
|
|
1316
|
+
readonly title: "Latest Attempt Status";
|
|
1317
|
+
};
|
|
1318
|
+
readonly latest_attempt_listing_incomplete_reason: {
|
|
1319
|
+
readonly anyOf: readonly [{
|
|
1320
|
+
readonly type: "string";
|
|
1321
|
+
}, {
|
|
1322
|
+
readonly type: "null";
|
|
1323
|
+
}];
|
|
1324
|
+
readonly title: "Latest Attempt Listing Incomplete Reason";
|
|
1325
|
+
};
|
|
1326
|
+
readonly latest_attempt_counts_incomplete_reason: {
|
|
1327
|
+
readonly anyOf: readonly [{
|
|
1328
|
+
readonly type: "string";
|
|
1329
|
+
}, {
|
|
1330
|
+
readonly type: "null";
|
|
1331
|
+
}];
|
|
1332
|
+
readonly title: "Latest Attempt Counts Incomplete Reason";
|
|
1333
|
+
};
|
|
1334
|
+
readonly observations_as_of: {
|
|
1335
|
+
readonly anyOf: readonly [{
|
|
1336
|
+
readonly type: "string";
|
|
1337
|
+
readonly format: "date-time";
|
|
1338
|
+
}, {
|
|
1339
|
+
readonly type: "null";
|
|
1340
|
+
}];
|
|
1341
|
+
readonly title: "Observations As Of";
|
|
1342
|
+
};
|
|
1343
|
+
readonly reported_counts_as_of: {
|
|
1344
|
+
readonly anyOf: readonly [{
|
|
1345
|
+
readonly type: "string";
|
|
1346
|
+
readonly format: "date-time";
|
|
1347
|
+
}, {
|
|
1348
|
+
readonly type: "null";
|
|
1349
|
+
}];
|
|
1350
|
+
readonly title: "Reported Counts As Of";
|
|
1351
|
+
};
|
|
1352
|
+
readonly repos_total_reported: {
|
|
1353
|
+
readonly anyOf: readonly [{
|
|
1354
|
+
readonly type: "integer";
|
|
1355
|
+
}, {
|
|
1356
|
+
readonly type: "null";
|
|
1357
|
+
}];
|
|
1358
|
+
readonly title: "Repos Total Reported";
|
|
1359
|
+
};
|
|
1360
|
+
readonly packages_total_reported: {
|
|
1361
|
+
readonly anyOf: readonly [{
|
|
1362
|
+
readonly type: "integer";
|
|
1363
|
+
}, {
|
|
1364
|
+
readonly type: "null";
|
|
1365
|
+
}];
|
|
1366
|
+
readonly title: "Packages Total Reported";
|
|
1367
|
+
};
|
|
1368
|
+
readonly packages_scanned: {
|
|
1369
|
+
readonly anyOf: readonly [{
|
|
1370
|
+
readonly type: "integer";
|
|
1371
|
+
}, {
|
|
1372
|
+
readonly type: "null";
|
|
1373
|
+
}];
|
|
1374
|
+
readonly title: "Packages Scanned";
|
|
1375
|
+
};
|
|
1376
|
+
readonly active_observations: {
|
|
1377
|
+
readonly type: "integer";
|
|
1378
|
+
readonly title: "Active Observations";
|
|
1379
|
+
readonly default: 0;
|
|
1380
|
+
};
|
|
1381
|
+
};
|
|
1382
|
+
readonly type: "object";
|
|
1383
|
+
readonly title: "GithubDependentsSummary";
|
|
1384
|
+
readonly description: "Freshness and completeness summary for a source repo's observations.\n\n``observations_as_of`` is the finish time of the latest applied\nlisting-complete run; ``reported_counts_as_of`` is the finish time of the\nlatest applied counts-complete run. The two can point to different runs,\nso the reported totals always carry their own timestamp. Reported header\ntotals may exceed the enumerable public entries and, for multi-package\nrepositories, are per-package sums that can double count a dependent\nusing several packages.";
|
|
1385
|
+
};
|
|
1386
|
+
export declare const GithubDependentsResponseSchema: {
|
|
1387
|
+
readonly properties: {
|
|
1388
|
+
readonly summary: {
|
|
1389
|
+
readonly $ref: "#/components/schemas/GithubDependentsSummary";
|
|
1390
|
+
};
|
|
1391
|
+
readonly observations: {
|
|
1392
|
+
readonly $ref: "#/components/schemas/PaginatedResponse_GithubDependentObservationItem_";
|
|
1393
|
+
};
|
|
1394
|
+
};
|
|
1395
|
+
readonly type: "object";
|
|
1396
|
+
readonly required: readonly ["summary", "observations"];
|
|
1397
|
+
readonly title: "GithubDependentsResponse";
|
|
1398
|
+
readonly description: "Summary plus paginated active observations for one source repo.";
|
|
1399
|
+
};
|
|
1176
1400
|
export declare const GitLogArtifactDetailResponseSchema: {
|
|
1177
1401
|
readonly properties: {
|
|
1178
1402
|
readonly id: {
|
|
@@ -537,8 +537,25 @@ export const RepoDetailResponseSchema = {
|
|
|
537
537
|
anyOf: [
|
|
538
538
|
{
|
|
539
539
|
items: {
|
|
540
|
-
|
|
541
|
-
|
|
540
|
+
properties: {
|
|
541
|
+
purl: {
|
|
542
|
+
type: 'string'
|
|
543
|
+
},
|
|
544
|
+
version: {
|
|
545
|
+
type: 'string'
|
|
546
|
+
},
|
|
547
|
+
release_date: {
|
|
548
|
+
type: 'string',
|
|
549
|
+
default: ''
|
|
550
|
+
}
|
|
551
|
+
},
|
|
552
|
+
type: 'object',
|
|
553
|
+
required: [
|
|
554
|
+
'purl',
|
|
555
|
+
'version'
|
|
556
|
+
],
|
|
557
|
+
title: 'Release',
|
|
558
|
+
description: 'One normalized release record keyed by package PURL + version.'
|
|
542
559
|
},
|
|
543
560
|
type: 'array'
|
|
544
561
|
},
|
|
@@ -1288,6 +1305,103 @@ export const PaginatedResponse_ProjectContributorSummary_Schema = {
|
|
|
1288
1305
|
],
|
|
1289
1306
|
title: 'PaginatedResponse[ProjectContributorSummary]'
|
|
1290
1307
|
};
|
|
1308
|
+
export const PaginatedResponse_GithubDependentObservationItem_Schema = {
|
|
1309
|
+
properties: {
|
|
1310
|
+
items: {
|
|
1311
|
+
items: {
|
|
1312
|
+
$ref: '#/components/schemas/GithubDependentObservationItem'
|
|
1313
|
+
},
|
|
1314
|
+
type: 'array',
|
|
1315
|
+
title: 'Items'
|
|
1316
|
+
},
|
|
1317
|
+
total: {
|
|
1318
|
+
type: 'integer',
|
|
1319
|
+
title: 'Total'
|
|
1320
|
+
},
|
|
1321
|
+
limit: {
|
|
1322
|
+
type: 'integer',
|
|
1323
|
+
title: 'Limit'
|
|
1324
|
+
},
|
|
1325
|
+
offset: {
|
|
1326
|
+
type: 'integer',
|
|
1327
|
+
title: 'Offset'
|
|
1328
|
+
}
|
|
1329
|
+
},
|
|
1330
|
+
type: 'object',
|
|
1331
|
+
required: [
|
|
1332
|
+
'items',
|
|
1333
|
+
'total',
|
|
1334
|
+
'limit',
|
|
1335
|
+
'offset'
|
|
1336
|
+
],
|
|
1337
|
+
title: 'PaginatedResponse[GithubDependentObservationItem]'
|
|
1338
|
+
};
|
|
1339
|
+
export const GithubDependentObservationItemSchema = {
|
|
1340
|
+
properties: {
|
|
1341
|
+
dependent_canonical_id: {
|
|
1342
|
+
type: 'string',
|
|
1343
|
+
title: 'Dependent Canonical Id'
|
|
1344
|
+
},
|
|
1345
|
+
dependent_repo_url: {
|
|
1346
|
+
type: 'string',
|
|
1347
|
+
title: 'Dependent Repo Url'
|
|
1348
|
+
},
|
|
1349
|
+
observed_owner: {
|
|
1350
|
+
type: 'string',
|
|
1351
|
+
title: 'Observed Owner'
|
|
1352
|
+
},
|
|
1353
|
+
observed_repo_name: {
|
|
1354
|
+
type: 'string',
|
|
1355
|
+
title: 'Observed Repo Name'
|
|
1356
|
+
},
|
|
1357
|
+
resolved_repo_canonical_id: {
|
|
1358
|
+
anyOf: [
|
|
1359
|
+
{
|
|
1360
|
+
type: 'string'
|
|
1361
|
+
},
|
|
1362
|
+
{
|
|
1363
|
+
type: 'null'
|
|
1364
|
+
}
|
|
1365
|
+
],
|
|
1366
|
+
title: 'Resolved Repo Canonical Id'
|
|
1367
|
+
},
|
|
1368
|
+
package_ids: {
|
|
1369
|
+
anyOf: [
|
|
1370
|
+
{
|
|
1371
|
+
items: {
|
|
1372
|
+
type: 'string'
|
|
1373
|
+
},
|
|
1374
|
+
type: 'array'
|
|
1375
|
+
},
|
|
1376
|
+
{
|
|
1377
|
+
type: 'null'
|
|
1378
|
+
}
|
|
1379
|
+
],
|
|
1380
|
+
title: 'Package Ids'
|
|
1381
|
+
},
|
|
1382
|
+
first_seen_at: {
|
|
1383
|
+
type: 'string',
|
|
1384
|
+
format: 'date-time',
|
|
1385
|
+
title: 'First Seen At'
|
|
1386
|
+
},
|
|
1387
|
+
last_seen_at: {
|
|
1388
|
+
type: 'string',
|
|
1389
|
+
format: 'date-time',
|
|
1390
|
+
title: 'Last Seen At'
|
|
1391
|
+
}
|
|
1392
|
+
},
|
|
1393
|
+
type: 'object',
|
|
1394
|
+
required: [
|
|
1395
|
+
'dependent_canonical_id',
|
|
1396
|
+
'dependent_repo_url',
|
|
1397
|
+
'observed_owner',
|
|
1398
|
+
'observed_repo_name',
|
|
1399
|
+
'first_seen_at',
|
|
1400
|
+
'last_seen_at'
|
|
1401
|
+
],
|
|
1402
|
+
title: 'GithubDependentObservationItem',
|
|
1403
|
+
description: 'One active GitHub dependent observation for a source repo.'
|
|
1404
|
+
};
|
|
1291
1405
|
export const PaginatedResponse_GitLogArtifactSummary_Schema = {
|
|
1292
1406
|
properties: {
|
|
1293
1407
|
items: {
|
|
@@ -1502,21 +1616,68 @@ export const HealthResponseSchema = {
|
|
|
1502
1616
|
properties: {
|
|
1503
1617
|
status: {
|
|
1504
1618
|
type: 'string',
|
|
1619
|
+
enum: [
|
|
1620
|
+
'live',
|
|
1621
|
+
'ready'
|
|
1622
|
+
],
|
|
1505
1623
|
title: 'Status'
|
|
1506
1624
|
},
|
|
1507
1625
|
version: {
|
|
1508
1626
|
type: 'string',
|
|
1509
1627
|
title: 'Version'
|
|
1628
|
+
},
|
|
1629
|
+
components: {
|
|
1630
|
+
$ref: '#/components/schemas/HealthComponents'
|
|
1510
1631
|
}
|
|
1511
1632
|
},
|
|
1512
1633
|
type: 'object',
|
|
1513
1634
|
required: [
|
|
1514
1635
|
'status',
|
|
1515
|
-
'version'
|
|
1636
|
+
'version',
|
|
1637
|
+
'components'
|
|
1516
1638
|
],
|
|
1517
1639
|
title: 'HealthResponse',
|
|
1518
1640
|
description: 'Response body for GET /health.'
|
|
1519
1641
|
};
|
|
1642
|
+
export const HealthComponentsSchema = {
|
|
1643
|
+
properties: {
|
|
1644
|
+
artifact_store: {
|
|
1645
|
+
type: 'string',
|
|
1646
|
+
enum: [
|
|
1647
|
+
'local',
|
|
1648
|
+
'IPFS'
|
|
1649
|
+
],
|
|
1650
|
+
title: 'Artifact Store'
|
|
1651
|
+
},
|
|
1652
|
+
database: {
|
|
1653
|
+
type: 'string',
|
|
1654
|
+
enum: [
|
|
1655
|
+
'ready',
|
|
1656
|
+
'not-configured'
|
|
1657
|
+
],
|
|
1658
|
+
title: 'Database'
|
|
1659
|
+
},
|
|
1660
|
+
schema_version: {
|
|
1661
|
+
anyOf: [
|
|
1662
|
+
{
|
|
1663
|
+
type: 'string'
|
|
1664
|
+
},
|
|
1665
|
+
{
|
|
1666
|
+
type: 'null'
|
|
1667
|
+
}
|
|
1668
|
+
],
|
|
1669
|
+
title: 'Schema Version'
|
|
1670
|
+
}
|
|
1671
|
+
},
|
|
1672
|
+
type: 'object',
|
|
1673
|
+
required: [
|
|
1674
|
+
'artifact_store',
|
|
1675
|
+
'database',
|
|
1676
|
+
'schema_version'
|
|
1677
|
+
],
|
|
1678
|
+
title: 'HealthComponents',
|
|
1679
|
+
description: 'Component-level readiness details for GET /health.'
|
|
1680
|
+
};
|
|
1520
1681
|
export const HTTPValidationErrorSchema = {
|
|
1521
1682
|
properties: {
|
|
1522
1683
|
detail: {
|
|
@@ -1530,6 +1691,137 @@ export const HTTPValidationErrorSchema = {
|
|
|
1530
1691
|
type: 'object',
|
|
1531
1692
|
title: 'HTTPValidationError'
|
|
1532
1693
|
};
|
|
1694
|
+
export const GithubDependentsSummarySchema = {
|
|
1695
|
+
properties: {
|
|
1696
|
+
latest_attempt_at: {
|
|
1697
|
+
anyOf: [
|
|
1698
|
+
{
|
|
1699
|
+
type: 'string',
|
|
1700
|
+
format: 'date-time'
|
|
1701
|
+
},
|
|
1702
|
+
{
|
|
1703
|
+
type: 'null'
|
|
1704
|
+
}
|
|
1705
|
+
],
|
|
1706
|
+
title: 'Latest Attempt At'
|
|
1707
|
+
},
|
|
1708
|
+
latest_attempt_status: {
|
|
1709
|
+
anyOf: [
|
|
1710
|
+
{
|
|
1711
|
+
type: 'string'
|
|
1712
|
+
},
|
|
1713
|
+
{
|
|
1714
|
+
type: 'null'
|
|
1715
|
+
}
|
|
1716
|
+
],
|
|
1717
|
+
title: 'Latest Attempt Status'
|
|
1718
|
+
},
|
|
1719
|
+
latest_attempt_listing_incomplete_reason: {
|
|
1720
|
+
anyOf: [
|
|
1721
|
+
{
|
|
1722
|
+
type: 'string'
|
|
1723
|
+
},
|
|
1724
|
+
{
|
|
1725
|
+
type: 'null'
|
|
1726
|
+
}
|
|
1727
|
+
],
|
|
1728
|
+
title: 'Latest Attempt Listing Incomplete Reason'
|
|
1729
|
+
},
|
|
1730
|
+
latest_attempt_counts_incomplete_reason: {
|
|
1731
|
+
anyOf: [
|
|
1732
|
+
{
|
|
1733
|
+
type: 'string'
|
|
1734
|
+
},
|
|
1735
|
+
{
|
|
1736
|
+
type: 'null'
|
|
1737
|
+
}
|
|
1738
|
+
],
|
|
1739
|
+
title: 'Latest Attempt Counts Incomplete Reason'
|
|
1740
|
+
},
|
|
1741
|
+
observations_as_of: {
|
|
1742
|
+
anyOf: [
|
|
1743
|
+
{
|
|
1744
|
+
type: 'string',
|
|
1745
|
+
format: 'date-time'
|
|
1746
|
+
},
|
|
1747
|
+
{
|
|
1748
|
+
type: 'null'
|
|
1749
|
+
}
|
|
1750
|
+
],
|
|
1751
|
+
title: 'Observations As Of'
|
|
1752
|
+
},
|
|
1753
|
+
reported_counts_as_of: {
|
|
1754
|
+
anyOf: [
|
|
1755
|
+
{
|
|
1756
|
+
type: 'string',
|
|
1757
|
+
format: 'date-time'
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
type: 'null'
|
|
1761
|
+
}
|
|
1762
|
+
],
|
|
1763
|
+
title: 'Reported Counts As Of'
|
|
1764
|
+
},
|
|
1765
|
+
repos_total_reported: {
|
|
1766
|
+
anyOf: [
|
|
1767
|
+
{
|
|
1768
|
+
type: 'integer'
|
|
1769
|
+
},
|
|
1770
|
+
{
|
|
1771
|
+
type: 'null'
|
|
1772
|
+
}
|
|
1773
|
+
],
|
|
1774
|
+
title: 'Repos Total Reported'
|
|
1775
|
+
},
|
|
1776
|
+
packages_total_reported: {
|
|
1777
|
+
anyOf: [
|
|
1778
|
+
{
|
|
1779
|
+
type: 'integer'
|
|
1780
|
+
},
|
|
1781
|
+
{
|
|
1782
|
+
type: 'null'
|
|
1783
|
+
}
|
|
1784
|
+
],
|
|
1785
|
+
title: 'Packages Total Reported'
|
|
1786
|
+
},
|
|
1787
|
+
packages_scanned: {
|
|
1788
|
+
anyOf: [
|
|
1789
|
+
{
|
|
1790
|
+
type: 'integer'
|
|
1791
|
+
},
|
|
1792
|
+
{
|
|
1793
|
+
type: 'null'
|
|
1794
|
+
}
|
|
1795
|
+
],
|
|
1796
|
+
title: 'Packages Scanned'
|
|
1797
|
+
},
|
|
1798
|
+
active_observations: {
|
|
1799
|
+
type: 'integer',
|
|
1800
|
+
title: 'Active Observations',
|
|
1801
|
+
default: 0
|
|
1802
|
+
}
|
|
1803
|
+
},
|
|
1804
|
+
type: 'object',
|
|
1805
|
+
title: 'GithubDependentsSummary',
|
|
1806
|
+
description: 'Freshness and completeness summary for a source repo\'s observations.\n\n``observations_as_of`` is the finish time of the latest applied\nlisting-complete run; ``reported_counts_as_of`` is the finish time of the\nlatest applied counts-complete run. The two can point to different runs,\nso the reported totals always carry their own timestamp. Reported header\ntotals may exceed the enumerable public entries and, for multi-package\nrepositories, are per-package sums that can double count a dependent\nusing several packages.'
|
|
1807
|
+
};
|
|
1808
|
+
export const GithubDependentsResponseSchema = {
|
|
1809
|
+
properties: {
|
|
1810
|
+
summary: {
|
|
1811
|
+
$ref: '#/components/schemas/GithubDependentsSummary'
|
|
1812
|
+
},
|
|
1813
|
+
observations: {
|
|
1814
|
+
$ref: '#/components/schemas/PaginatedResponse_GithubDependentObservationItem_'
|
|
1815
|
+
}
|
|
1816
|
+
},
|
|
1817
|
+
type: 'object',
|
|
1818
|
+
required: [
|
|
1819
|
+
'summary',
|
|
1820
|
+
'observations'
|
|
1821
|
+
],
|
|
1822
|
+
title: 'GithubDependentsResponse',
|
|
1823
|
+
description: 'Summary plus paginated active observations for one source repo.'
|
|
1824
|
+
};
|
|
1533
1825
|
export const GitLogArtifactDetailResponseSchema = {
|
|
1534
1826
|
properties: {
|
|
1535
1827
|
id: {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { GetContributorData, GetContributorErrors, GetContributorResponses, GetGitlogArtifactData, GetGitlogArtifactErrors, GetGitlogArtifactResponses, GetMetadataData, GetMetadataResponses, GetProjectContributorsData, GetProjectContributorsErrors, GetProjectContributorsResponses, GetProjectData, GetProjectDependsOnData, GetProjectDependsOnErrors, GetProjectDependsOnResponses, GetProjectErrors, GetProjectHasDependentsData, GetProjectHasDependentsErrors, GetProjectHasDependentsResponses, GetProjectReposData, GetProjectReposErrors, GetProjectReposResponses, GetProjectResponses, GetRepoContributorsData, GetRepoContributorsErrors, GetRepoContributorsResponses, GetRepoData, GetRepoDependsOnData, GetRepoDependsOnErrors, GetRepoDependsOnResponses, GetRepoErrors, GetRepoHasDependentsData, GetRepoHasDependentsErrors, GetRepoHasDependentsResponses, GetRepoResponses, GetSbomSubmissionData, GetSbomSubmissionErrors, GetSbomSubmissionResponses, HealthData, HealthResponses, IngestSbomData, IngestSbomErrors, IngestSbomResponses, ListContributorsData, ListContributorsErrors, ListContributorsResponses, ListGitlogArtifactsData, ListGitlogArtifactsErrors, ListGitlogArtifactsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListReposData, ListReposErrors, ListReposResponses, ListSbomSubmissionsData, ListSbomSubmissionsErrors, ListSbomSubmissionsResponses } from './types.gen';
|
|
2
|
+
import type { GetContributorData, GetContributorErrors, GetContributorResponses, GetGitlogArtifactData, GetGitlogArtifactErrors, GetGitlogArtifactResponses, GetMetadataData, GetMetadataResponses, GetProjectContributorsData, GetProjectContributorsErrors, GetProjectContributorsResponses, GetProjectData, GetProjectDependsOnData, GetProjectDependsOnErrors, GetProjectDependsOnResponses, GetProjectErrors, GetProjectHasDependentsData, GetProjectHasDependentsErrors, GetProjectHasDependentsResponses, GetProjectReposData, GetProjectReposErrors, GetProjectReposResponses, GetProjectResponses, GetRepoContributorsData, GetRepoContributorsErrors, GetRepoContributorsResponses, GetRepoData, GetRepoDependsOnData, GetRepoDependsOnErrors, GetRepoDependsOnResponses, GetRepoErrors, GetRepoGithubDependentsData, GetRepoGithubDependentsErrors, GetRepoGithubDependentsResponses, GetRepoHasDependentsData, GetRepoHasDependentsErrors, GetRepoHasDependentsResponses, GetRepoResponses, GetSbomSubmissionData, GetSbomSubmissionErrors, GetSbomSubmissionResponses, HealthData, HealthResponses, IngestSbomData, IngestSbomErrors, IngestSbomResponses, ListContributorsData, ListContributorsErrors, ListContributorsResponses, ListGitlogArtifactsData, ListGitlogArtifactsErrors, ListGitlogArtifactsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListReposData, ListReposErrors, ListReposResponses, ListSbomSubmissionsData, ListSbomSubmissionsErrors, ListSbomSubmissionsResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -14,13 +14,9 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
14
14
|
meta?: Record<string, unknown>;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Readiness check
|
|
18
18
|
*
|
|
19
|
-
* Return the current
|
|
20
|
-
*
|
|
21
|
-
* This endpoint is intentionally dependency-free (no DB call) so that it
|
|
22
|
-
* remains responsive even when the database is unreachable. A richer check
|
|
23
|
-
* with named component statuses (db, graph) will be added in A2.
|
|
19
|
+
* Return the current readiness status and application version.
|
|
24
20
|
*/
|
|
25
21
|
export declare const health: <ThrowOnError extends boolean = false>(options?: Options<HealthData, ThrowOnError>) => import("./client").RequestResult<HealthResponses, unknown, ThrowOnError, "fields">;
|
|
26
22
|
/**
|
|
@@ -53,12 +49,14 @@ export declare const getMetadata: <ThrowOnError extends boolean = false>(options
|
|
|
53
49
|
/**
|
|
54
50
|
* List projects
|
|
55
51
|
*
|
|
56
|
-
* Paginated list of SCF-funded projects with optional filters.
|
|
52
|
+
* Paginated list of SCF-funded projects with optional filters and sorting.
|
|
57
53
|
*
|
|
58
54
|
* - **project_type**: filter by `public-good` or `scf-project`.
|
|
59
55
|
* - **activity_status**: filter by lifecycle status (`live`, `in-dev`, etc.).
|
|
60
56
|
* - **search**: case-insensitive substring match on `display_name`.
|
|
61
|
-
* -
|
|
57
|
+
* - **sort**: comma-separated `field:direction` pairs for server-side ordering.
|
|
58
|
+
* - **category**: filter by exact project category string.
|
|
59
|
+
* - Default order is `canonical_id` for deterministic pagination.
|
|
62
60
|
*/
|
|
63
61
|
export declare const listProjects: <ThrowOnError extends boolean = false>(options?: Options<ListProjectsData, ThrowOnError>) => import("./client").RequestResult<ListProjectsResponses, ListProjectsErrors, ThrowOnError, "fields">;
|
|
64
62
|
/**
|
|
@@ -107,11 +105,12 @@ export declare const getProjectHasDependents: <ThrowOnError extends boolean = fa
|
|
|
107
105
|
/**
|
|
108
106
|
* List repos
|
|
109
107
|
*
|
|
110
|
-
* Paginated list of in-ecosystem repos with optional filters.
|
|
108
|
+
* Paginated list of in-ecosystem repos with optional filters and sorting.
|
|
111
109
|
*
|
|
112
110
|
* - **project_id**: filter to repos belonging to a specific project.
|
|
113
111
|
* - **search**: case-insensitive substring match on `display_name`.
|
|
114
|
-
* -
|
|
112
|
+
* - **sort**: comma-separated `field:direction` pairs for server-side ordering.
|
|
113
|
+
* - Default order is `canonical_id` for deterministic pagination.
|
|
115
114
|
*/
|
|
116
115
|
export declare const listRepos: <ThrowOnError extends boolean = false>(options?: Options<ListReposData, ThrowOnError>) => import("./client").RequestResult<ListReposResponses, ListReposErrors, ThrowOnError, "fields">;
|
|
117
116
|
/**
|
|
@@ -132,6 +131,17 @@ export declare const getRepoDependsOn: <ThrowOnError extends boolean = false>(op
|
|
|
132
131
|
* type, version range, and confidence level.
|
|
133
132
|
*/
|
|
134
133
|
export declare const getRepoHasDependents: <ThrowOnError extends boolean = false>(options: Options<GetRepoHasDependentsData, ThrowOnError>) => import("./client").RequestResult<GetRepoHasDependentsResponses, GetRepoHasDependentsErrors, ThrowOnError, "fields">;
|
|
134
|
+
/**
|
|
135
|
+
* Public GitHub dependents observed for a repo
|
|
136
|
+
*
|
|
137
|
+
* Active GitHub dependents observations plus freshness/completeness summary.
|
|
138
|
+
*
|
|
139
|
+
* Collection/audit data scraped from the public GitHub dependents page.
|
|
140
|
+
* Deliberately separate from the dependency-graph ``has-dependents``
|
|
141
|
+
* endpoint: observations are not ``DependsOn`` relationships and feed no
|
|
142
|
+
* metric. Retired observations are not exposed here.
|
|
143
|
+
*/
|
|
144
|
+
export declare const getRepoGithubDependents: <ThrowOnError extends boolean = false>(options: Options<GetRepoGithubDependentsData, ThrowOnError>) => import("./client").RequestResult<GetRepoGithubDependentsResponses, GetRepoGithubDependentsErrors, ThrowOnError, "fields">;
|
|
135
145
|
/**
|
|
136
146
|
* Contributors for a repo
|
|
137
147
|
*
|
|
@@ -1,13 +1,9 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
import { client } from './client.gen';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Readiness check
|
|
5
5
|
*
|
|
6
|
-
* Return the current
|
|
7
|
-
*
|
|
8
|
-
* This endpoint is intentionally dependency-free (no DB call) so that it
|
|
9
|
-
* remains responsive even when the database is unreachable. A richer check
|
|
10
|
-
* with named component statuses (db, graph) will be added in A2.
|
|
6
|
+
* Return the current readiness status and application version.
|
|
11
7
|
*/
|
|
12
8
|
export const health = (options) => (options?.client ?? client).get({ url: '/health', ...options });
|
|
13
9
|
/**
|
|
@@ -40,12 +36,14 @@ export const getMetadata = (options) => (options?.client ?? client).get({ url: '
|
|
|
40
36
|
/**
|
|
41
37
|
* List projects
|
|
42
38
|
*
|
|
43
|
-
* Paginated list of SCF-funded projects with optional filters.
|
|
39
|
+
* Paginated list of SCF-funded projects with optional filters and sorting.
|
|
44
40
|
*
|
|
45
41
|
* - **project_type**: filter by `public-good` or `scf-project`.
|
|
46
42
|
* - **activity_status**: filter by lifecycle status (`live`, `in-dev`, etc.).
|
|
47
43
|
* - **search**: case-insensitive substring match on `display_name`.
|
|
48
|
-
* -
|
|
44
|
+
* - **sort**: comma-separated `field:direction` pairs for server-side ordering.
|
|
45
|
+
* - **category**: filter by exact project category string.
|
|
46
|
+
* - Default order is `canonical_id` for deterministic pagination.
|
|
49
47
|
*/
|
|
50
48
|
export const listProjects = (options) => (options?.client ?? client).get({ url: '/projects', ...options });
|
|
51
49
|
/**
|
|
@@ -94,11 +92,12 @@ export const getProjectHasDependents = (options) => (options.client ?? client).g
|
|
|
94
92
|
/**
|
|
95
93
|
* List repos
|
|
96
94
|
*
|
|
97
|
-
* Paginated list of in-ecosystem repos with optional filters.
|
|
95
|
+
* Paginated list of in-ecosystem repos with optional filters and sorting.
|
|
98
96
|
*
|
|
99
97
|
* - **project_id**: filter to repos belonging to a specific project.
|
|
100
98
|
* - **search**: case-insensitive substring match on `display_name`.
|
|
101
|
-
* -
|
|
99
|
+
* - **sort**: comma-separated `field:direction` pairs for server-side ordering.
|
|
100
|
+
* - Default order is `canonical_id` for deterministic pagination.
|
|
102
101
|
*/
|
|
103
102
|
export const listRepos = (options) => (options?.client ?? client).get({ url: '/repos', ...options });
|
|
104
103
|
/**
|
|
@@ -119,6 +118,17 @@ export const getRepoDependsOn = (options) => (options.client ?? client).get({ ur
|
|
|
119
118
|
* type, version range, and confidence level.
|
|
120
119
|
*/
|
|
121
120
|
export const getRepoHasDependents = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}/has-dependents', ...options });
|
|
121
|
+
/**
|
|
122
|
+
* Public GitHub dependents observed for a repo
|
|
123
|
+
*
|
|
124
|
+
* Active GitHub dependents observations plus freshness/completeness summary.
|
|
125
|
+
*
|
|
126
|
+
* Collection/audit data scraped from the public GitHub dependents page.
|
|
127
|
+
* Deliberately separate from the dependency-graph ``has-dependents``
|
|
128
|
+
* endpoint: observations are not ``DependsOn`` relationships and feed no
|
|
129
|
+
* metric. Retired observations are not exposed here.
|
|
130
|
+
*/
|
|
131
|
+
export const getRepoGithubDependents = (options) => (options.client ?? client).get({ url: '/repos/{canonical_id}/github-dependents', ...options });
|
|
122
132
|
/**
|
|
123
133
|
* Contributors for a repo
|
|
124
134
|
*
|
|
@@ -314,7 +314,9 @@ export type RepoDetailResponse = {
|
|
|
314
314
|
* Releases
|
|
315
315
|
*/
|
|
316
316
|
releases: Array<{
|
|
317
|
-
|
|
317
|
+
purl: string;
|
|
318
|
+
version: string;
|
|
319
|
+
release_date?: string;
|
|
318
320
|
}> | null;
|
|
319
321
|
parent_project: ProjectSummary | null;
|
|
320
322
|
/**
|
|
@@ -730,6 +732,66 @@ export type PaginatedResponseProjectContributorSummary = {
|
|
|
730
732
|
*/
|
|
731
733
|
offset: number;
|
|
732
734
|
};
|
|
735
|
+
/**
|
|
736
|
+
* PaginatedResponse[GithubDependentObservationItem]
|
|
737
|
+
*/
|
|
738
|
+
export type PaginatedResponseGithubDependentObservationItem = {
|
|
739
|
+
/**
|
|
740
|
+
* Items
|
|
741
|
+
*/
|
|
742
|
+
items: Array<GithubDependentObservationItem>;
|
|
743
|
+
/**
|
|
744
|
+
* Total
|
|
745
|
+
*/
|
|
746
|
+
total: number;
|
|
747
|
+
/**
|
|
748
|
+
* Limit
|
|
749
|
+
*/
|
|
750
|
+
limit: number;
|
|
751
|
+
/**
|
|
752
|
+
* Offset
|
|
753
|
+
*/
|
|
754
|
+
offset: number;
|
|
755
|
+
};
|
|
756
|
+
/**
|
|
757
|
+
* GithubDependentObservationItem
|
|
758
|
+
*
|
|
759
|
+
* One active GitHub dependent observation for a source repo.
|
|
760
|
+
*/
|
|
761
|
+
export type GithubDependentObservationItem = {
|
|
762
|
+
/**
|
|
763
|
+
* Dependent Canonical Id
|
|
764
|
+
*/
|
|
765
|
+
dependent_canonical_id: string;
|
|
766
|
+
/**
|
|
767
|
+
* Dependent Repo Url
|
|
768
|
+
*/
|
|
769
|
+
dependent_repo_url: string;
|
|
770
|
+
/**
|
|
771
|
+
* Observed Owner
|
|
772
|
+
*/
|
|
773
|
+
observed_owner: string;
|
|
774
|
+
/**
|
|
775
|
+
* Observed Repo Name
|
|
776
|
+
*/
|
|
777
|
+
observed_repo_name: string;
|
|
778
|
+
/**
|
|
779
|
+
* Resolved Repo Canonical Id
|
|
780
|
+
*/
|
|
781
|
+
resolved_repo_canonical_id?: string | null;
|
|
782
|
+
/**
|
|
783
|
+
* Package Ids
|
|
784
|
+
*/
|
|
785
|
+
package_ids?: Array<string> | null;
|
|
786
|
+
/**
|
|
787
|
+
* First Seen At
|
|
788
|
+
*/
|
|
789
|
+
first_seen_at: string;
|
|
790
|
+
/**
|
|
791
|
+
* Last Seen At
|
|
792
|
+
*/
|
|
793
|
+
last_seen_at: string;
|
|
794
|
+
};
|
|
733
795
|
/**
|
|
734
796
|
* PaginatedResponse[GitLogArtifactSummary]
|
|
735
797
|
*/
|
|
@@ -872,11 +934,31 @@ export type HealthResponse = {
|
|
|
872
934
|
/**
|
|
873
935
|
* Status
|
|
874
936
|
*/
|
|
875
|
-
status:
|
|
937
|
+
status: 'live' | 'ready';
|
|
876
938
|
/**
|
|
877
939
|
* Version
|
|
878
940
|
*/
|
|
879
941
|
version: string;
|
|
942
|
+
components: HealthComponents;
|
|
943
|
+
};
|
|
944
|
+
/**
|
|
945
|
+
* HealthComponents
|
|
946
|
+
*
|
|
947
|
+
* Component-level readiness details for GET /health.
|
|
948
|
+
*/
|
|
949
|
+
export type HealthComponents = {
|
|
950
|
+
/**
|
|
951
|
+
* Artifact Store
|
|
952
|
+
*/
|
|
953
|
+
artifact_store: 'local' | 'IPFS';
|
|
954
|
+
/**
|
|
955
|
+
* Database
|
|
956
|
+
*/
|
|
957
|
+
database: 'ready' | 'not-configured';
|
|
958
|
+
/**
|
|
959
|
+
* Schema Version
|
|
960
|
+
*/
|
|
961
|
+
schema_version: string | null;
|
|
880
962
|
};
|
|
881
963
|
/**
|
|
882
964
|
* HTTPValidationError
|
|
@@ -887,6 +969,70 @@ export type HttpValidationError = {
|
|
|
887
969
|
*/
|
|
888
970
|
detail?: Array<ValidationError>;
|
|
889
971
|
};
|
|
972
|
+
/**
|
|
973
|
+
* GithubDependentsSummary
|
|
974
|
+
*
|
|
975
|
+
* Freshness and completeness summary for a source repo's observations.
|
|
976
|
+
*
|
|
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.
|
|
984
|
+
*/
|
|
985
|
+
export type GithubDependentsSummary = {
|
|
986
|
+
/**
|
|
987
|
+
* Latest Attempt At
|
|
988
|
+
*/
|
|
989
|
+
latest_attempt_at?: string | null;
|
|
990
|
+
/**
|
|
991
|
+
* Latest Attempt Status
|
|
992
|
+
*/
|
|
993
|
+
latest_attempt_status?: string | null;
|
|
994
|
+
/**
|
|
995
|
+
* Latest Attempt Listing Incomplete Reason
|
|
996
|
+
*/
|
|
997
|
+
latest_attempt_listing_incomplete_reason?: string | null;
|
|
998
|
+
/**
|
|
999
|
+
* Latest Attempt Counts Incomplete Reason
|
|
1000
|
+
*/
|
|
1001
|
+
latest_attempt_counts_incomplete_reason?: string | null;
|
|
1002
|
+
/**
|
|
1003
|
+
* Observations As Of
|
|
1004
|
+
*/
|
|
1005
|
+
observations_as_of?: string | null;
|
|
1006
|
+
/**
|
|
1007
|
+
* Reported Counts As Of
|
|
1008
|
+
*/
|
|
1009
|
+
reported_counts_as_of?: string | null;
|
|
1010
|
+
/**
|
|
1011
|
+
* Repos Total Reported
|
|
1012
|
+
*/
|
|
1013
|
+
repos_total_reported?: number | null;
|
|
1014
|
+
/**
|
|
1015
|
+
* Packages Total Reported
|
|
1016
|
+
*/
|
|
1017
|
+
packages_total_reported?: number | null;
|
|
1018
|
+
/**
|
|
1019
|
+
* Packages Scanned
|
|
1020
|
+
*/
|
|
1021
|
+
packages_scanned?: number | null;
|
|
1022
|
+
/**
|
|
1023
|
+
* Active Observations
|
|
1024
|
+
*/
|
|
1025
|
+
active_observations?: number;
|
|
1026
|
+
};
|
|
1027
|
+
/**
|
|
1028
|
+
* GithubDependentsResponse
|
|
1029
|
+
*
|
|
1030
|
+
* Summary plus paginated active observations for one source repo.
|
|
1031
|
+
*/
|
|
1032
|
+
export type GithubDependentsResponse = {
|
|
1033
|
+
summary: GithubDependentsSummary;
|
|
1034
|
+
observations: PaginatedResponseGithubDependentObservationItem;
|
|
1035
|
+
};
|
|
890
1036
|
/**
|
|
891
1037
|
* GitLogArtifactDetailResponse
|
|
892
1038
|
*
|
|
@@ -1137,6 +1283,18 @@ export type ListProjectsData = {
|
|
|
1137
1283
|
* Search
|
|
1138
1284
|
*/
|
|
1139
1285
|
search?: string | null;
|
|
1286
|
+
/**
|
|
1287
|
+
* Sort
|
|
1288
|
+
*
|
|
1289
|
+
* Comma-separated field:direction pairs, e.g. 'criticality_score:desc,display_name:asc'.
|
|
1290
|
+
*/
|
|
1291
|
+
sort?: string | null;
|
|
1292
|
+
/**
|
|
1293
|
+
* Category
|
|
1294
|
+
*
|
|
1295
|
+
* Filter by project category (exact match).
|
|
1296
|
+
*/
|
|
1297
|
+
category?: string | null;
|
|
1140
1298
|
/**
|
|
1141
1299
|
* Limit
|
|
1142
1300
|
*
|
|
@@ -1337,6 +1495,12 @@ export type ListReposData = {
|
|
|
1337
1495
|
* Search
|
|
1338
1496
|
*/
|
|
1339
1497
|
search?: string | null;
|
|
1498
|
+
/**
|
|
1499
|
+
* Sort
|
|
1500
|
+
*
|
|
1501
|
+
* Comma-separated field:direction pairs, e.g. 'adoption_stars:desc,display_name:asc'.
|
|
1502
|
+
*/
|
|
1503
|
+
sort?: string | null;
|
|
1340
1504
|
/**
|
|
1341
1505
|
* Limit
|
|
1342
1506
|
*
|
|
@@ -1420,6 +1584,44 @@ export type GetRepoHasDependentsResponses = {
|
|
|
1420
1584
|
200: Array<RepoDependency>;
|
|
1421
1585
|
};
|
|
1422
1586
|
export type GetRepoHasDependentsResponse = GetRepoHasDependentsResponses[keyof GetRepoHasDependentsResponses];
|
|
1587
|
+
export type GetRepoGithubDependentsData = {
|
|
1588
|
+
body?: never;
|
|
1589
|
+
path: {
|
|
1590
|
+
/**
|
|
1591
|
+
* Canonical Id
|
|
1592
|
+
*/
|
|
1593
|
+
canonical_id: string;
|
|
1594
|
+
};
|
|
1595
|
+
query?: {
|
|
1596
|
+
/**
|
|
1597
|
+
* Limit
|
|
1598
|
+
*
|
|
1599
|
+
* Maximum number of items to return
|
|
1600
|
+
*/
|
|
1601
|
+
limit?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* Offset
|
|
1604
|
+
*
|
|
1605
|
+
* Number of items to skip
|
|
1606
|
+
*/
|
|
1607
|
+
offset?: number;
|
|
1608
|
+
};
|
|
1609
|
+
url: '/repos/{canonical_id}/github-dependents';
|
|
1610
|
+
};
|
|
1611
|
+
export type GetRepoGithubDependentsErrors = {
|
|
1612
|
+
/**
|
|
1613
|
+
* Validation Error
|
|
1614
|
+
*/
|
|
1615
|
+
422: HttpValidationError;
|
|
1616
|
+
};
|
|
1617
|
+
export type GetRepoGithubDependentsError = GetRepoGithubDependentsErrors[keyof GetRepoGithubDependentsErrors];
|
|
1618
|
+
export type GetRepoGithubDependentsResponses = {
|
|
1619
|
+
/**
|
|
1620
|
+
* Successful Response
|
|
1621
|
+
*/
|
|
1622
|
+
200: GithubDependentsResponse;
|
|
1623
|
+
};
|
|
1624
|
+
export type GetRepoGithubDependentsResponse = GetRepoGithubDependentsResponses[keyof GetRepoGithubDependentsResponses];
|
|
1423
1625
|
export type GetRepoContributorsData = {
|
|
1424
1626
|
body?: never;
|
|
1425
1627
|
path: {
|