@artifact-keeper/sdk 1.1.9-rc.1 → 1.2.1
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/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/sdk.gen.ts +454 -17
- package/src/types.gen.ts +2338 -118
package/src/sdk.gen.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client';
|
|
4
4
|
import { client } from './client.gen';
|
|
5
|
-
import type { AcknowledgeFindingData, AcknowledgeFindingErrors, AcknowledgeFindingResponses, AddArtifactLabelData, AddArtifactLabelErrors, AddArtifactLabelResponses, AddBuildArtifactsData, AddBuildArtifactsErrors, AddBuildArtifactsResponses, AddLabelData, AddLabelErrors, AddLabelResponses, AddMembersData, AddMembersErrors, AddMembersResponses, AddRepoLabelData, AddRepoLabelErrors, AddRepoLabelResponses, AddVirtualMemberData, AddVirtualMemberErrors, AddVirtualMemberResponses, AdvancedSearchData, AdvancedSearchResponses, AnnouncePeerData, AnnouncePeerErrors, AnnouncePeerResponses, ApprovePackageData, ApprovePackageResponses, ApprovePromotionData, ApprovePromotionErrors, ApprovePromotionResponses, AssignRepoData, AssignRepoErrors, AssignRepoResponses, AssignRoleData, AssignRoleResponses, BlockPackageData, BlockPackageResponses, BulkApproveData, BulkApproveResponses, BulkBlockData, BulkBlockResponses, CancelBackupData, CancelBackupErrors, CancelBackupResponses, CancelData, CancelErrors, CancelMigrationData, CancelMigrationErrors, CancelMigrationResponses, CancelResponses, CaptureSnapshotData, CaptureSnapshotResponses, ChangePasswordData, ChangePasswordErrors, ChangePasswordResponses, CheckLicenseComplianceData, CheckLicenseComplianceErrors, CheckLicenseComplianceResponses, ChecksumSearchData, ChecksumSearchErrors, ChecksumSearchResponses, CompleteChunkData, CompleteChunkResponses, CompleteData, CompleteErrors, CompleteResponses, CompleteSessionData, CompleteSessionResponses, ConvertSbomData, ConvertSbomErrors, ConvertSbomResponses, CreateApiTokenData, CreateApiTokenErrors, CreateApiTokenResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateBuildData, CreateBuildErrors, CreateBuildResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateCurationRuleData, CreateCurationRuleResponses, CreateDownloadTicketData, CreateDownloadTicketErrors, CreateDownloadTicketResponses, CreateGateData, CreateGateErrors, CreateGateResponses, CreateGroupData, CreateGroupErrors, CreateGroupResponses, CreateInstanceData, CreateInstanceResponses, CreateKeyData, CreateKeyErrors, CreateKeyResponses, CreateLdapData, CreateLdapErrors, CreateLdapResponses, CreateLifecyclePolicyData, CreateLifecyclePolicyResponses, CreateMigrationData, CreateMigrationErrors, CreateMigrationResponses, CreateOidcData, CreateOidcErrors, CreateOidcResponses, CreatePermissionData, CreatePermissionErrors, CreatePermissionResponses, CreatePolicyData, CreatePolicyErrors, CreatePolicyResponses, CreateRepositoryData, CreateRepositoryErrors, CreateRepositoryResponses, CreateRuleData, CreateRuleErrors, CreateRuleResponses, CreateSamlData, CreateSamlErrors, CreateSamlResponses, CreateServiceAccountData, CreateServiceAccountErrors, CreateServiceAccountResponses, CreateSessionData, CreateSessionErrors, CreateSessionResponses, CreateSyncPolicyData, CreateSyncPolicyErrors, CreateSyncPolicyResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserApiTokenData, CreateUserApiTokenErrors, CreateUserApiTokenResponses, CreateUserData, CreateUserErrors, CreateUserResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, DeleteArtifactData, DeleteArtifactErrors, DeleteArtifactLabelData, DeleteArtifactLabelErrors, DeleteArtifactLabelResponses, DeleteArtifactResponses, DeleteBackupData, DeleteBackupErrors, DeleteBackupResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteCrashData, DeleteCrashResponses, DeleteCurationRuleData, DeleteCurationRuleResponses, DeleteGateData, DeleteGateErrors, DeleteGateResponses, DeleteGroupData, DeleteGroupErrors, DeleteGroupResponses, DeleteInstanceData, DeleteInstanceResponses, DeleteKeyData, DeleteKeyErrors, DeleteKeyResponses, DeleteLabelData, DeleteLabelErrors, DeleteLabelResponses, DeleteLdapData, DeleteLdapErrors, DeleteLdapResponses, DeleteLicensePolicyData, DeleteLicensePolicyErrors, DeleteLicensePolicyResponses, DeleteLifecyclePolicyData, DeleteLifecyclePolicyResponses, DeleteMigrationData, DeleteMigrationErrors, DeleteMigrationResponses, DeleteOidcData, DeleteOidcErrors, DeleteOidcResponses, DeletePermissionData, DeletePermissionErrors, DeletePermissionResponses, DeletePolicyData, DeletePolicyErrors, DeletePolicyResponses, DeleteRepoLabelData, DeleteRepoLabelErrors, DeleteRepoLabelResponses, DeleteRepositoryData, DeleteRepositoryErrors, DeleteRepositoryResponses, DeleteRuleData, DeleteRuleErrors, DeleteRuleResponses, DeleteSamlData, DeleteSamlErrors, DeleteSamlResponses, DeleteSbomData, DeleteSbomErrors, DeleteSbomResponses, DeleteServiceAccountData, DeleteServiceAccountErrors, DeleteServiceAccountResponses, DeleteSyncPolicyData, DeleteSyncPolicyErrors, DeleteSyncPolicyResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DisableFormatHandlerData, DisableFormatHandlerResponses, DisablePluginData, DisablePluginErrors, DisablePluginResponses, DisableTotpData, DisableTotpErrors, DisableTotpResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, DiscoverPeersData, DiscoverPeersResponses, DownloadArtifactData, DownloadArtifactErrors, DownloadArtifactResponses, DtStatusData, DtStatusResponses, EnableFormatHandlerData, EnableFormatHandlerResponses, EnablePluginData, EnablePluginErrors, EnablePluginResponses, EnableTotpData, EnableTotpErrors, EnableTotpResponses, EnableWebhookData, EnableWebhookErrors, EnableWebhookResponses, EvaluateGateData, EvaluateGateErrors, EvaluateGateResponses, EvaluatePoliciesData, EvaluatePoliciesErrors, EvaluatePoliciesResponses, EvaluateRuleData, EvaluateRuleErrors, EvaluateRuleResponses, ExchangeCodeData, ExchangeCodeErrors, ExchangeCodeResponses, ExecuteAllPoliciesData, ExecuteAllPoliciesResponses, ExecuteBackupData, ExecuteBackupErrors, ExecuteBackupResponses, ExecutePolicyData, ExecutePolicyResponses, FailChunkData, FailChunkResponses, FailSessionData, FailSessionResponses, GenerateSbomData, GenerateSbomErrors, GenerateSbomResponses, GetAlertStatesData, GetAlertStatesResponses, GetAllScoresData, GetAllScoresResponses, GetApprovalData, GetApprovalErrors, GetApprovalResponses, GetArtifactData, GetArtifactErrors, GetArtifactHealthData, GetArtifactHealthErrors, GetArtifactHealthResponses, GetArtifactMetadataData, GetArtifactMetadataErrors, GetArtifactMetadataResponses, GetArtifactResponses, GetArtifactStatsData, GetArtifactStatsErrors, GetArtifactStatsResponses, GetAssessmentData, GetAssessmentErrors, GetAssessmentResponses, GetAssignedReposData, GetAssignedReposErrors, GetAssignedReposResponses, GetBackupData, GetBackupErrors, GetBackupResponses, GetBuildData, GetBuildDiffData, GetBuildDiffResponses, GetBuildErrors, GetBuildResponses, GetCacheTtlData, GetCacheTtlErrors, GetCacheTtlResponses, GetCheckData, GetCheckErrors, GetCheckResponses, GetChunkAvailabilityData, GetChunkAvailabilityErrors, GetChunkAvailabilityResponses, GetChunkManifestData, GetChunkManifestResponses, GetConnectionData, GetConnectionErrors, GetConnectionResponses, GetContentData, GetContentErrors, GetContentResponses, GetCrashData, GetCrashResponses, GetCurationPackageData, GetCurationPackageResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetCveHistoryData, GetCveHistoryResponses, GetCveTrendsData, GetCveTrendsResponses, GetDashboardData, GetDashboardResponses, GetDownloadTrendsData, GetDownloadTrendsResponses, GetFormatHandlerData, GetFormatHandlerErrors, GetFormatHandlerResponses, GetGateData, GetGateErrors, GetGateResponses, GetGroupData, GetGroupErrors, GetGroupResponses, GetGrowthSummaryData, GetGrowthSummaryResponses, GetHealthDashboardData, GetHealthDashboardResponses, GetHealthLogData, GetHealthLogResponses, GetIdentityData, GetIdentityErrors, GetIdentityResponses, GetKeyData, GetKeyErrors, GetKeyResponses, GetLdapData, GetLdapErrors, GetLdapResponses, GetLicensePolicyData, GetLicensePolicyErrors, GetLicensePolicyResponses, GetLifecyclePolicyData, GetLifecyclePolicyResponses, GetMigrationData, GetMigrationErrors, GetMigrationReportData, GetMigrationReportErrors, GetMigrationReportResponses, GetMigrationResponses, GetOidcData, GetOidcErrors, GetOidcResponses, GetPackageData, GetPackageErrors, GetPackageResponses, GetPackageVersionsData, GetPackageVersionsErrors, GetPackageVersionsResponses, GetPeerData, GetPeerErrors, GetPeerResponses, GetPeersWithChunksData, GetPeersWithChunksResponses, GetPermissionData, GetPermissionErrors, GetPermissionResponses, GetPluginConfigData, GetPluginConfigErrors, GetPluginConfigResponses, GetPluginData, GetPluginErrors, GetPluginEventsData, GetPluginEventsResponses, GetPluginResponses, GetPolicyData, GetPolicyErrors, GetPolicyResponses, GetPortfolioMetricsData, GetPortfolioMetricsResponses, GetProjectComponentsData, GetProjectComponentsResponses, GetProjectData, GetProjectFindingsData, GetProjectFindingsResponses, GetProjectMetricsData, GetProjectMetricsHistoryData, GetProjectMetricsHistoryResponses, GetProjectMetricsResponses, GetProjectResponses, GetProjectViolationsData, GetProjectViolationsResponses, GetPublicKeyData, GetPublicKeyErrors, GetPublicKeyResponses, GetRepoHealthData, GetRepoHealthErrors, GetRepoHealthResponses, GetRepoPublicKeyData, GetRepoPublicKeyErrors, GetRepoPublicKeyResponses, GetRepoSecurityData, GetRepoSecurityErrors, GetRepoSecurityResponses, GetRepoSigningConfigData, GetRepoSigningConfigErrors, GetRepoSigningConfigResponses, GetRepositoryArtifactMetadataData, GetRepositoryArtifactMetadataErrors, GetRepositoryArtifactMetadataResponses, GetRepositoryData, GetRepositoryErrors, GetRepositoryResponses, GetRepositoryTrendData, GetRepositoryTrendResponses, GetRuleData, GetRuleErrors, GetRuleResponses, GetSamlData, GetSamlErrors, GetSamlResponses, GetSbomByArtifactData, GetSbomByArtifactErrors, GetSbomByArtifactResponses, GetSbomComponentsData, GetSbomComponentsErrors, GetSbomComponentsResponses, GetSbomData, GetSbomErrors, GetSbomResponses, GetScanData, GetScanErrors, GetScanResponses, GetScoredPeersData, GetScoredPeersResponses, GetServiceAccountData, GetServiceAccountErrors, GetServiceAccountResponses, GetSessionData, GetSessionResponses, GetSessionStatusData, GetSessionStatusErrors, GetSessionStatusResponses, GetSettingsData, GetSettingsErrors, GetSettingsResponses, GetStaleArtifactsData, GetStaleArtifactsResponses, GetStorageBreakdownData, GetStorageBreakdownResponses, GetStorageTrendData, GetStorageTrendResponses, GetSyncPolicyData, GetSyncPolicyErrors, GetSyncPolicyResponses, GetSyncTasksData, GetSyncTasksErrors, GetSyncTasksResponses, GetSystemStatsData, GetSystemStatsErrors, GetSystemStatsResponses, GetTelemetrySettingsData, GetTelemetrySettingsResponses, GetTreeData, GetTreeErrors, GetTreeResponses, GetUserData, GetUserErrors, GetUserResponses, GetUserRolesData, GetUserRolesResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, HealthCheckData, HealthCheckErrors, HealthCheckResponses, HeartbeatData, HeartbeatErrors, HeartbeatResponses, InitTransferData, InitTransferResponses, InstallFromGitData, InstallFromGitResponses, InstallFromLocalData, InstallFromLocalErrors, InstallFromLocalResponses, InstallFromZipData, InstallFromZipErrors, InstallFromZipResponses, InstallPluginData, InstallPluginErrors, InstallPluginResponses, LdapLoginData, LdapLoginErrors, LdapLoginResponses, ListApprovalHistoryData, ListApprovalHistoryResponses, ListArtifactLabelsData, ListArtifactLabelsErrors, ListArtifactLabelsResponses, ListArtifactScansData, ListArtifactScansResponses, ListArtifactsData, ListArtifactsErrors, ListArtifactsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListBuildsData, ListBuildsResponses, ListCheckIssuesData, ListCheckIssuesErrors, ListCheckIssuesResponses, ListChecksData, ListChecksResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCrashesData, ListCrashesResponses, ListCurationPackagesData, ListCurationPackagesResponses, ListCurationRulesData, ListCurationRulesResponses, ListDeliveriesData, ListDeliveriesErrors, ListDeliveriesResponses, ListDependencyTrackPoliciesData, ListDependencyTrackPoliciesResponses, ListFindingsData, ListFindingsErrors, ListFindingsResponses, ListFormatHandlersData, ListFormatHandlersResponses, ListGatesData, ListGatesResponses, ListGroupsData, ListGroupsErrors, ListGroupsResponses, ListInstancesData, ListInstancesResponses, ListKeysData, ListKeysErrors, ListKeysResponses, ListLabelsData, ListLabelsErrors, ListLabelsResponses, ListLdapData, ListLdapErrors, ListLdapResponses, ListLicensePoliciesData, ListLicensePoliciesResponses, ListLifecyclePoliciesData, ListLifecyclePoliciesResponses, ListMigrationItemsData, ListMigrationItemsErrors, ListMigrationItemsResponses, ListMigrationsData, ListMigrationsErrors, ListMigrationsResponses, ListOidcData, ListOidcErrors, ListOidcResponses, ListPackagesData, ListPackagesErrors, ListPackagesResponses, ListPeerConnectionsData, ListPeerConnectionsErrors, ListPeerConnectionsResponses, ListPeersData, ListPeersErrors, ListPeersResponses, ListPendingApprovalsData, ListPendingApprovalsResponses, ListPendingCrashesData, ListPendingCrashesResponses, ListPermissionsData, ListPermissionsErrors, ListPermissionsResponses, ListPluginsData, ListPluginsResponses, ListPoliciesData, ListPoliciesResponses, ListProjectsData, ListProjectsResponses, ListProvidersData, ListProvidersResponses, ListRepoLabelsData, ListRepoLabelsErrors, ListRepoLabelsResponses, ListRepoScansData, ListRepoScansErrors, ListRepoScansResponses, ListRepositoriesData, ListRepositoriesResponses, ListRulesData, ListRulesErrors, ListRulesResponses, ListSamlData, ListSamlErrors, ListSamlResponses, ListSbomsData, ListSbomsResponses, ListScanConfigsData, ListScanConfigsResponses, ListScansData, ListScansResponses, ListServiceAccountsData, ListServiceAccountsErrors, ListServiceAccountsResponses, ListSourceRepositoriesData, ListSourceRepositoriesErrors, ListSourceRepositoriesResponses, ListSsoProvidersAdminData, ListSsoProvidersAdminErrors, ListSsoProvidersAdminResponses, ListStorageBackendsData, ListStorageBackendsErrors, ListStorageBackendsResponses, ListSyncPoliciesData, ListSyncPoliciesErrors, ListSyncPoliciesResponses, ListTokensData, ListTokensErrors, ListTokensResponses, ListUsersData, ListUsersResponses, ListUserTokensData, ListUserTokensErrors, ListUserTokensResponses, ListVirtualMembersData, ListVirtualMembersErrors, ListVirtualMembersResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, LivenessCheckData, LivenessCheckResponses, LoginData, LoginErrors, LoginResponses, LogoutData, LogoutResponses, MarkUnreachableData, MarkUnreachableResponses, MetricsData, MetricsResponses, OidcCallbackData, OidcCallbackErrors, OidcLoginData, OidcLoginErrors, PauseMigrationData, PauseMigrationErrors, PauseMigrationResponses, PreviewPolicyData, PreviewPolicyResponses, PreviewRepoSelectorData, PreviewRepoSelectorErrors, PreviewRepoSelectorResponses, PreviewSyncPolicyData, PreviewSyncPolicyErrors, PreviewSyncPolicyResponses, ProbePeerData, ProbePeerResponses, PromoteArtifactData, PromoteArtifactErrors, PromoteArtifactResponses, PromoteArtifactsBulkData, PromoteArtifactsBulkErrors, PromoteArtifactsBulkResponses, PromotionHistoryData, PromotionHistoryErrors, PromotionHistoryResponses, ProxyDeleteData, ProxyDeleteResponses, ProxyGetData, ProxyGetResponses, ProxyPostData, ProxyPostResponses, ProxyPutData, ProxyPutResponses, QuickSearchData, QuickSearchResponses, ReadinessCheckData, ReadinessCheckErrors, ReadinessCheckResponses, RecentData, RecentResponses, RedeliverData, RedeliverErrors, RedeliverResponses, ReEvaluateData, ReEvaluateResponses, RefreshTokenData, RefreshTokenErrors, RefreshTokenResponses, RegisterPeerData, RegisterPeerErrors, RegisterPeerResponses, RejectArtifactData, RejectArtifactErrors, RejectArtifactResponses, RejectPromotionData, RejectPromotionErrors, RejectPromotionResponses, ReloadPluginData, ReloadPluginResponses, RemoveMembersData, RemoveMembersErrors, RemoveMembersResponses, RemoveVirtualMemberData, RemoveVirtualMemberErrors, RemoveVirtualMemberResponses, RequestApprovalData, RequestApprovalErrors, RequestApprovalResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, ResumeMigrationData, ResumeMigrationErrors, ResumeMigrationResponses, RetryChunkData, RetryChunkResponses, RevokeAcknowledgmentData, RevokeAcknowledgmentErrors, RevokeAcknowledgmentResponses, RevokeApiTokenData, RevokeApiTokenErrors, RevokeApiTokenResponses, RevokeKeyData, RevokeKeyErrors, RevokeKeyResponses, RevokeRoleData, RevokeRoleErrors, RevokeRoleResponses, RevokeTokenData, RevokeTokenErrors, RevokeTokenResponses, RevokeUserApiTokenData, RevokeUserApiTokenErrors, RevokeUserApiTokenResponses, RotateKeyData, RotateKeyErrors, RotateKeyResponses, RunAssessmentData, RunAssessmentErrors, RunAssessmentResponses, RunCleanupData, RunCleanupErrors, RunCleanupResponses, RunHealthCheckData, RunHealthCheckResponses, RunStorageGcData, RunStorageGcResponses, SamlAcsData, SamlAcsErrors, SamlLoginData, SamlLoginErrors, SetArtifactLabelsData, SetArtifactLabelsErrors, SetArtifactLabelsResponses, SetCacheTtlData, SetCacheTtlErrors, SetCacheTtlResponses, SetLabelsData, SetLabelsErrors, SetLabelsResponses, SetRepoLabelsData, SetRepoLabelsErrors, SetRepoLabelsResponses, SetupStatusData, SetupStatusResponses, SetUpstreamAuthData, SetUpstreamAuthErrors, SetUpstreamAuthResponses, SetupTotpData, SetupTotpErrors, SetupTotpResponses, StartMigrationData, StartMigrationErrors, StartMigrationResponses, StatsData, StatsResponses, StreamMigrationProgressData, StreamMigrationProgressErrors, StreamMigrationProgressResponses, SubmitCrashesData, SubmitCrashesResponses, SuggestData, SuggestResponses, SuppressAlertData, SuppressAlertResponses, SuppressIssueData, SuppressIssueErrors, SuppressIssueResponses, TestConnectionData, TestConnectionErrors, TestConnectionResponses, TestFormatHandlerData, TestFormatHandlerResponses, TestLdapData, TestLdapErrors, TestLdapResponses, TestUpstreamData, TestUpstreamErrors, TestUpstreamResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, ToggleLdapData, ToggleLdapErrors, ToggleLdapResponses, ToggleOidcData, ToggleOidcErrors, ToggleOidcResponses, TogglePolicyData, TogglePolicyErrors, TogglePolicyResponses, ToggleSamlData, ToggleSamlErrors, ToggleSamlResponses, TrendingData, TrendingResponses, TriggerChecksData, TriggerChecksErrors, TriggerChecksResponses, TriggerReindexData, TriggerReindexErrors, TriggerReindexResponses, TriggerScanData, TriggerScanErrors, TriggerScanResponses, TriggerSearchReindexData, TriggerSearchReindexErrors, TriggerSearchReindexResponses, TriggerSyncData, TriggerSyncErrors, TriggerSyncResponses, UnassignRepoData, UnassignRepoErrors, UnassignRepoResponses, UninstallPluginData, UninstallPluginErrors, UninstallPluginResponses, UnregisterPeerData, UnregisterPeerErrors, UnregisterPeerResponses, UnsuppressIssueData, UnsuppressIssueErrors, UnsuppressIssueResponses, UpdateAnalysisData, UpdateAnalysisResponses, UpdateBuildData, UpdateBuildErrors, UpdateBuildResponses, UpdateChunkAvailabilityData, UpdateChunkAvailabilityResponses, UpdateCurationRuleData, UpdateCurationRuleResponses, UpdateCveStatusData, UpdateCveStatusErrors, UpdateCveStatusResponses, UpdateGateData, UpdateGateErrors, UpdateGateResponses, UpdateGroupData, UpdateGroupErrors, UpdateGroupResponses, UpdateLdapData, UpdateLdapErrors, UpdateLdapResponses, UpdateLifecyclePolicyData, UpdateLifecyclePolicyResponses, UpdateNetworkProfileData, UpdateNetworkProfileResponses, UpdateOidcData, UpdateOidcErrors, UpdateOidcResponses, UpdatePermissionData, UpdatePermissionErrors, UpdatePermissionResponses, UpdatePluginConfigData, UpdatePluginConfigErrors, UpdatePluginConfigResponses, UpdatePolicyData, UpdatePolicyErrors, UpdatePolicyResponses, UpdateRepoSecurityData, UpdateRepoSecurityErrors, UpdateRepoSecurityResponses, UpdateRepoSigningConfigData, UpdateRepoSigningConfigErrors, UpdateRepoSigningConfigResponses, UpdateRepositoryData, UpdateRepositoryErrors, UpdateRepositoryResponses, UpdateRuleData, UpdateRuleErrors, UpdateRuleResponses, UpdateSamlData, UpdateSamlErrors, UpdateSamlResponses, UpdateServiceAccountData, UpdateServiceAccountErrors, UpdateServiceAccountResponses, UpdateSettingsData, UpdateSettingsErrors, UpdateSettingsResponses, UpdateSyncPolicyData, UpdateSyncPolicyErrors, UpdateSyncPolicyResponses, UpdateTelemetrySettingsData, UpdateTelemetrySettingsResponses, UpdateUserData, UpdateUserErrors, UpdateUserResponses, UpdateVirtualMembersData, UpdateVirtualMembersErrors, UpdateVirtualMembersResponses, UploadArtifactData, UploadArtifactErrors, UploadArtifactResponses, UploadChunkData, UploadChunkErrors, UploadChunkResponses, UpsertLicensePolicyData, UpsertLicensePolicyErrors, UpsertLicensePolicyResponses, VerifyTotpData, VerifyTotpErrors, VerifyTotpResponses } from './types.gen';
|
|
5
|
+
import type { AcknowledgeFindingData, AcknowledgeFindingErrors, AcknowledgeFindingResponses, AddArtifactLabelData, AddArtifactLabelErrors, AddArtifactLabelResponses, AddBuildArtifactsData, AddBuildArtifactsErrors, AddBuildArtifactsResponses, AddLabelData, AddLabelErrors, AddLabelResponses, AddMembersData, AddMembersErrors, AddMembersResponses, AddRepoLabelData, AddRepoLabelErrors, AddRepoLabelResponses, AddVirtualMemberData, AddVirtualMemberErrors, AddVirtualMemberResponses, AdvancedSearchData, AdvancedSearchResponses, AnnouncePeerData, AnnouncePeerErrors, AnnouncePeerResponses, ApprovePackageData, ApprovePackageResponses, ApprovePromotionData, ApprovePromotionErrors, ApprovePromotionResponses, AssignRepoData, AssignRepoErrors, AssignRepoResponses, AssignRoleData, AssignRoleResponses, BlockPackageData, BlockPackageResponses, BulkApproveData, BulkApproveResponses, BulkBlockData, BulkBlockResponses, CancelBackupData, CancelBackupErrors, CancelBackupResponses, CancelData, CancelErrors, CancelMigrationData, CancelMigrationErrors, CancelMigrationResponses, CancelResponses, CaptureSnapshotData, CaptureSnapshotResponses, ChangePasswordData, ChangePasswordErrors, ChangePasswordResponses, CheckLicenseComplianceData, CheckLicenseComplianceErrors, CheckLicenseComplianceResponses, ChecksumSearchData, ChecksumSearchErrors, ChecksumSearchResponses, CompleteChunkData, CompleteChunkResponses, CompleteData, CompleteErrors, CompleteResponses, CompleteSessionData, CompleteSessionResponses, ConvertSbomData, ConvertSbomErrors, ConvertSbomResponses, CreateApiTokenData, CreateApiTokenErrors, CreateApiTokenResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateBuildData, CreateBuildErrors, CreateBuildResponses, CreateConnectionData, CreateConnectionErrors, CreateConnectionResponses, CreateCurationRuleData, CreateCurationRuleResponses, CreateDownloadTicketData, CreateDownloadTicketErrors, CreateDownloadTicketResponses, CreateGateData, CreateGateErrors, CreateGateResponses, CreateGroupData, CreateGroupErrors, CreateGroupResponses, CreateInstanceData, CreateInstanceResponses, CreateKeyData, CreateKeyErrors, CreateKeyResponses, CreateLdapData, CreateLdapErrors, CreateLdapResponses, CreateLifecyclePolicyData, CreateLifecyclePolicyResponses, CreateMigrationData, CreateMigrationErrors, CreateMigrationResponses, CreateOidcData, CreateOidcErrors, CreateOidcResponses, CreatePermissionData, CreatePermissionErrors, CreatePermissionResponses, CreatePolicyData, CreatePolicyErrors, CreatePolicyResponses, CreateRepositoryData, CreateRepositoryErrors, CreateRepositoryResponses, CreateRepoTokenData, CreateRepoTokenErrors, CreateRepoTokenResponses, CreateRuleData, CreateRuleErrors, CreateRuleResponses, CreateSamlData, CreateSamlErrors, CreateSamlResponses, CreateServiceAccountData, CreateServiceAccountErrors, CreateServiceAccountResponses, CreateSessionData, CreateSessionErrors, CreateSessionResponses, CreateSubscriptionData, CreateSubscriptionErrors, CreateSubscriptionResponses, CreateSyncPolicyData, CreateSyncPolicyErrors, CreateSyncPolicyResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserApiTokenData, CreateUserApiTokenErrors, CreateUserApiTokenResponses, CreateUserData, CreateUserErrors, CreateUserResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, DeleteArtifactData, DeleteArtifactErrors, DeleteArtifactLabelData, DeleteArtifactLabelErrors, DeleteArtifactLabelResponses, DeleteArtifactResponses, DeleteBackupData, DeleteBackupErrors, DeleteBackupResponses, DeleteConnectionData, DeleteConnectionErrors, DeleteConnectionResponses, DeleteCrashData, DeleteCrashResponses, DeleteCurationRuleData, DeleteCurationRuleResponses, DeleteGateData, DeleteGateErrors, DeleteGateResponses, DeleteGroupData, DeleteGroupErrors, DeleteGroupResponses, DeleteInstanceData, DeleteInstanceResponses, DeleteKeyData, DeleteKeyErrors, DeleteKeyResponses, DeleteLabelData, DeleteLabelErrors, DeleteLabelResponses, DeleteLdapData, DeleteLdapErrors, DeleteLdapResponses, DeleteLicensePolicyData, DeleteLicensePolicyErrors, DeleteLicensePolicyResponses, DeleteLifecyclePolicyData, DeleteLifecyclePolicyResponses, DeleteMigrationData, DeleteMigrationErrors, DeleteMigrationResponses, DeleteOidcData, DeleteOidcErrors, DeleteOidcResponses, DeletePermissionData, DeletePermissionErrors, DeletePermissionResponses, DeletePolicyData, DeletePolicyErrors, DeletePolicyResponses, DeletePypiTrackData, DeletePypiTrackErrors, DeletePypiTrackResponses, DeleteRepoLabelData, DeleteRepoLabelErrors, DeleteRepoLabelResponses, DeleteRepositoryData, DeleteRepositoryErrors, DeleteRepositoryResponses, DeleteRoutingRulesData, DeleteRoutingRulesErrors, DeleteRoutingRulesResponses, DeleteRuleData, DeleteRuleErrors, DeleteRuleResponses, DeleteSamlData, DeleteSamlErrors, DeleteSamlResponses, DeleteSbomData, DeleteSbomErrors, DeleteSbomResponses, DeleteServiceAccountData, DeleteServiceAccountErrors, DeleteServiceAccountResponses, DeleteSubscriptionData, DeleteSubscriptionErrors, DeleteSubscriptionResponses, DeleteSyncPolicyData, DeleteSyncPolicyErrors, DeleteSyncPolicyResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DisableFormatHandlerData, DisableFormatHandlerResponses, DisablePluginData, DisablePluginErrors, DisablePluginResponses, DisableTotpData, DisableTotpErrors, DisableTotpResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, DiscoverPeersData, DiscoverPeersResponses, DownloadArtifactData, DownloadArtifactErrors, DownloadArtifactResponses, DtStatusData, DtStatusResponses, EnableFormatHandlerData, EnableFormatHandlerResponses, EnablePluginData, EnablePluginErrors, EnablePluginResponses, EnableTotpData, EnableTotpErrors, EnableTotpResponses, EnableWebhookData, EnableWebhookErrors, EnableWebhookResponses, EvaluateGateData, EvaluateGateErrors, EvaluateGateResponses, EvaluatePoliciesData, EvaluatePoliciesErrors, EvaluatePoliciesResponses, EvaluateRuleData, EvaluateRuleErrors, EvaluateRuleResponses, ExchangeCodeData, ExchangeCodeErrors, ExchangeCodeResponses, ExecuteAllPoliciesData, ExecuteAllPoliciesResponses, ExecuteBackupData, ExecuteBackupErrors, ExecuteBackupResponses, ExecutePolicyData, ExecutePolicyResponses, FailChunkData, FailChunkResponses, FailSessionData, FailSessionResponses, ForcePasswordChangeData, ForcePasswordChangeErrors, ForcePasswordChangeResponses, GenerateSbomData, GenerateSbomErrors, GenerateSbomResponses, GetAlertStatesData, GetAlertStatesResponses, GetAllScoresData, GetAllScoresErrors, GetAllScoresResponses, GetApprovalData, GetApprovalErrors, GetApprovalResponses, GetArtifactData, GetArtifactErrors, GetArtifactHealthData, GetArtifactHealthErrors, GetArtifactHealthResponses, GetArtifactMetadataData, GetArtifactMetadataErrors, GetArtifactMetadataResponses, GetArtifactResponses, GetArtifactStatsData, GetArtifactStatsErrors, GetArtifactStatsResponses, GetAssessmentData, GetAssessmentErrors, GetAssessmentResponses, GetAssignedReposData, GetAssignedReposErrors, GetAssignedReposResponses, GetBackupData, GetBackupErrors, GetBackupResponses, GetBuildData, GetBuildDiffData, GetBuildDiffResponses, GetBuildErrors, GetBuildResponses, GetCacheTtlData, GetCacheTtlErrors, GetCacheTtlResponses, GetCheckData, GetCheckErrors, GetCheckResponses, GetChunkAvailabilityData, GetChunkAvailabilityErrors, GetChunkAvailabilityResponses, GetChunkManifestData, GetChunkManifestResponses, GetConnectionData, GetConnectionErrors, GetConnectionResponses, GetContentData, GetContentErrors, GetContentResponses, GetCrashData, GetCrashResponses, GetCurationPackageData, GetCurationPackageResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetCveHistoryByArtifactData, GetCveHistoryByArtifactErrors, GetCveHistoryByArtifactResponses, GetCveHistoryByCveData, GetCveHistoryByCveErrors, GetCveHistoryByCveResponses, GetCveHistoryData, GetCveHistoryErrors, GetCveHistoryResponses, GetCveTrendsData, GetCveTrendsResponses, GetDashboardData, GetDashboardErrors, GetDashboardResponses, GetDownloadTrendsData, GetDownloadTrendsResponses, GetFormatHandlerData, GetFormatHandlerErrors, GetFormatHandlerResponses, GetGateData, GetGateErrors, GetGateResponses, GetGroupData, GetGroupErrors, GetGroupResponses, GetGrowthSummaryData, GetGrowthSummaryResponses, GetHealthDashboardData, GetHealthDashboardResponses, GetHealthLogData, GetHealthLogResponses, GetIdentityData, GetIdentityErrors, GetIdentityResponses, GetKeyData, GetKeyErrors, GetKeyResponses, GetLdapData, GetLdapErrors, GetLdapResponses, GetLicensePolicyData, GetLicensePolicyErrors, GetLicensePolicyResponses, GetLifecyclePolicyData, GetLifecyclePolicyResponses, GetMigrationData, GetMigrationErrors, GetMigrationReportData, GetMigrationReportErrors, GetMigrationReportResponses, GetMigrationResponses, GetOidcData, GetOidcErrors, GetOidcResponses, GetPackageData, GetPackageErrors, GetPackageResponses, GetPackageVersionsData, GetPackageVersionsErrors, GetPackageVersionsResponses, GetPeerData, GetPeerErrors, GetPeerResponses, GetPeersWithChunksData, GetPeersWithChunksResponses, GetPermissionData, GetPermissionErrors, GetPermissionResponses, GetPluginConfigData, GetPluginConfigErrors, GetPluginConfigResponses, GetPluginData, GetPluginErrors, GetPluginEventsData, GetPluginEventsResponses, GetPluginResponses, GetPolicyData, GetPolicyErrors, GetPolicyResponses, GetPortfolioMetricsData, GetPortfolioMetricsResponses, GetProjectComponentsData, GetProjectComponentsResponses, GetProjectData, GetProjectFindingsData, GetProjectFindingsResponses, GetProjectMetricsData, GetProjectMetricsHistoryData, GetProjectMetricsHistoryResponses, GetProjectMetricsResponses, GetProjectResponses, GetProjectViolationsData, GetProjectViolationsResponses, GetPublicKeyData, GetPublicKeyErrors, GetPublicKeyResponses, GetQuarantineStatusData, GetQuarantineStatusErrors, GetQuarantineStatusResponses, GetReleaseTargetData, GetReleaseTargetErrors, GetReleaseTargetResponses, GetRepoHealthData, GetRepoHealthErrors, GetRepoHealthResponses, GetRepoPublicKeyData, GetRepoPublicKeyErrors, GetRepoPublicKeyResponses, GetRepoSecurityData, GetRepoSecurityErrors, GetRepoSecurityResponses, GetRepoSigningConfigData, GetRepoSigningConfigErrors, GetRepoSigningConfigResponses, GetRepositoryArtifactMetadataData, GetRepositoryArtifactMetadataErrors, GetRepositoryArtifactMetadataResponses, GetRepositoryData, GetRepositoryErrors, GetRepositoryResponses, GetRepositoryTrendData, GetRepositoryTrendResponses, GetRepoTokenData, GetRepoTokenErrors, GetRepoTokenResponses, GetRoutingRulesData, GetRoutingRulesErrors, GetRoutingRulesResponses, GetRuleData, GetRuleErrors, GetRuleResponses, GetSamlData, GetSamlErrors, GetSamlResponses, GetSbomByArtifactData, GetSbomByArtifactErrors, GetSbomByArtifactResponses, GetSbomComponentsData, GetSbomComponentsErrors, GetSbomComponentsResponses, GetSbomData, GetSbomErrors, GetSbomResponses, GetScanData, GetScanErrors, GetScanResponses, GetScoredPeersData, GetScoredPeersResponses, GetServiceAccountData, GetServiceAccountErrors, GetServiceAccountResponses, GetSessionData, GetSessionResponses, GetSessionStatusData, GetSessionStatusErrors, GetSessionStatusResponses, GetSettingsData, GetSettingsErrors, GetSettingsResponses, GetStaleArtifactsData, GetStaleArtifactsResponses, GetStorageBreakdownData, GetStorageBreakdownResponses, GetStorageTrendData, GetStorageTrendResponses, GetSubscriptionData, GetSubscriptionErrors, GetSubscriptionResponses, GetSyncPolicyData, GetSyncPolicyErrors, GetSyncPolicyResponses, GetSyncTasksData, GetSyncTasksErrors, GetSyncTasksResponses, GetSystemConfigData, GetSystemConfigResponses, GetSystemStatsData, GetSystemStatsErrors, GetSystemStatsResponses, GetTelemetrySettingsData, GetTelemetrySettingsResponses, GetTreeData, GetTreeErrors, GetTreeResponses, GetUserData, GetUserErrors, GetUserResponses, GetUserRolesData, GetUserRolesResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, HealthCheckData, HealthCheckErrors, HealthCheckResponses, HeartbeatData, HeartbeatErrors, HeartbeatResponses, InitTransferData, InitTransferResponses, InstallFromGitData, InstallFromGitResponses, InstallFromLocalData, InstallFromLocalErrors, InstallFromLocalResponses, InstallFromZipData, InstallFromZipErrors, InstallFromZipResponses, InstallPluginData, InstallPluginErrors, InstallPluginResponses, InvalidateCacheData, InvalidateCacheErrors, InvalidateCacheResponses, LdapLoginData, LdapLoginErrors, LdapLoginResponses, ListApprovalHistoryData, ListApprovalHistoryResponses, ListArtifactLabelsData, ListArtifactLabelsErrors, ListArtifactLabelsResponses, ListArtifactScansData, ListArtifactScansResponses, ListArtifactsData, ListArtifactsErrors, ListArtifactsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListBuildsData, ListBuildsResponses, ListCheckIssuesData, ListCheckIssuesErrors, ListCheckIssuesResponses, ListChecksData, ListChecksResponses, ListConnectionsData, ListConnectionsErrors, ListConnectionsResponses, ListCrashesData, ListCrashesResponses, ListCurationPackagesData, ListCurationPackagesResponses, ListCurationRulesData, ListCurationRulesResponses, ListDeliveriesData, ListDeliveriesErrors, ListDeliveriesResponses, ListDependencyTrackPoliciesData, ListDependencyTrackPoliciesResponses, ListFindingsData, ListFindingsErrors, ListFindingsResponses, ListFormatHandlersData, ListFormatHandlersResponses, ListGatesData, ListGatesResponses, ListGroupsData, ListGroupsErrors, ListGroupsResponses, ListInstancesData, ListInstancesResponses, ListKeysData, ListKeysErrors, ListKeysResponses, ListLabelsData, ListLabelsErrors, ListLabelsResponses, ListLdapData, ListLdapErrors, ListLdapResponses, ListLicensePoliciesData, ListLicensePoliciesResponses, ListLifecyclePoliciesData, ListLifecyclePoliciesResponses, ListMigrationItemsData, ListMigrationItemsErrors, ListMigrationItemsResponses, ListMigrationsData, ListMigrationsErrors, ListMigrationsResponses, ListOidcData, ListOidcErrors, ListOidcResponses, ListPackagesData, ListPackagesErrors, ListPackagesResponses, ListPeerConnectionsData, ListPeerConnectionsErrors, ListPeerConnectionsResponses, ListPeersData, ListPeersErrors, ListPeersResponses, ListPendingApprovalsData, ListPendingApprovalsResponses, ListPendingCrashesData, ListPendingCrashesResponses, ListPermissionsData, ListPermissionsErrors, ListPermissionsResponses, ListPluginsData, ListPluginsResponses, ListPoliciesData, ListPoliciesResponses, ListProjectsData, ListProjectsResponses, ListProvidersData, ListProvidersResponses, ListPypiTracksData, ListPypiTracksErrors, ListPypiTracksResponses, ListRepoLabelsData, ListRepoLabelsErrors, ListRepoLabelsResponses, ListRepoScansData, ListRepoScansErrors, ListRepoScansResponses, ListRepositoriesData, ListRepositoriesResponses, ListRepoTokensData, ListRepoTokensErrors, ListRepoTokensResponses, ListRulesData, ListRulesErrors, ListRulesResponses, ListSamlData, ListSamlErrors, ListSamlResponses, ListSbomsData, ListSbomsResponses, ListScanConfigsData, ListScanConfigsResponses, ListScansData, ListScansResponses, ListServiceAccountsData, ListServiceAccountsErrors, ListServiceAccountsResponses, ListSourceRepositoriesData, ListSourceRepositoriesErrors, ListSourceRepositoriesResponses, ListSsoProvidersAdminData, ListSsoProvidersAdminErrors, ListSsoProvidersAdminResponses, ListStorageBackendsData, ListStorageBackendsErrors, ListStorageBackendsResponses, ListSubscriptionsData, ListSubscriptionsErrors, ListSubscriptionsResponses, ListSyncPoliciesData, ListSyncPoliciesErrors, ListSyncPoliciesResponses, ListTokensData, ListTokensErrors, ListTokensResponses, ListUsersData, ListUsersResponses, ListUserTokensData, ListUserTokensErrors, ListUserTokensResponses, ListVirtualMembersData, ListVirtualMembersErrors, ListVirtualMembersResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, LivenessCheckData, LivenessCheckResponses, LoginData, LoginErrors, LoginResponses, LogoutData, LogoutResponses, MarkUnreachableData, MarkUnreachableResponses, MetricsData, MetricsResponses, OciBlobReportData, OciBlobReportResponses, OidcCallbackData, OidcCallbackErrors, OidcLoginData, OidcLoginErrors, PauseMigrationData, PauseMigrationErrors, PauseMigrationResponses, PreviewPolicyData, PreviewPolicyResponses, PreviewRepoSelectorData, PreviewRepoSelectorErrors, PreviewRepoSelectorResponses, PreviewSyncPolicyData, PreviewSyncPolicyErrors, PreviewSyncPolicyResponses, ProbePeerData, ProbePeerResponses, PromoteArtifactData, PromoteArtifactErrors, PromoteArtifactResponses, PromoteArtifactsBulkData, PromoteArtifactsBulkErrors, PromoteArtifactsBulkResponses, PromotionHistoryData, PromotionHistoryErrors, PromotionHistoryResponses, ProxyDeleteData, ProxyDeleteResponses, ProxyGetData, ProxyGetResponses, ProxyPostData, ProxyPostResponses, ProxyPutData, ProxyPutResponses, PutPypiTrackData, PutPypiTrackErrors, PutPypiTrackResponses, QuickSearchData, QuickSearchResponses, ReadinessCheckData, ReadinessCheckErrors, ReadinessCheckResponses, RecentData, RecentResponses, RedeliverData, RedeliverErrors, RedeliverResponses, ReEvaluateData, ReEvaluateResponses, RefreshTokenData, RefreshTokenErrors, RefreshTokenResponses, RegisterPeerData, RegisterPeerErrors, RegisterPeerResponses, RejectArtifactData, RejectArtifactErrors, RejectArtifactResponses, RejectPromotionData, RejectPromotionErrors, RejectPromotionResponses, RejectQuarantinedArtifactData, RejectQuarantinedArtifactErrors, RejectQuarantinedArtifactResponses, ReleaseArtifactData, ReleaseArtifactErrors, ReleaseArtifactResponses, ReloadPluginData, ReloadPluginResponses, RemoveMembersData, RemoveMembersErrors, RemoveMembersResponses, RemoveVirtualMemberData, RemoveVirtualMemberErrors, RemoveVirtualMemberResponses, RequestApprovalData, RequestApprovalErrors, RequestApprovalResponses, RescanForInventoryData, RescanForInventoryErrors, RescanForInventoryResponses, ResetPasswordData, ResetPasswordErrors, ResetPasswordResponses, RestoreBackupData, RestoreBackupErrors, RestoreBackupResponses, ResumeMigrationData, ResumeMigrationErrors, ResumeMigrationResponses, RetryChunkData, RetryChunkResponses, RevokeAcknowledgmentData, RevokeAcknowledgmentErrors, RevokeAcknowledgmentResponses, RevokeApiTokenData, RevokeApiTokenErrors, RevokeApiTokenResponses, RevokeKeyData, RevokeKeyErrors, RevokeKeyResponses, RevokeRepoTokenData, RevokeRepoTokenErrors, RevokeRepoTokenResponses, RevokeRoleData, RevokeRoleErrors, RevokeRoleResponses, RevokeTokenData, RevokeTokenErrors, RevokeTokenResponses, RevokeUserApiTokenData, RevokeUserApiTokenErrors, RevokeUserApiTokenResponses, RotateKeyData, RotateKeyErrors, RotateKeyResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, RunAssessmentData, RunAssessmentErrors, RunAssessmentResponses, RunCleanupData, RunCleanupErrors, RunCleanupResponses, RunHealthCheckData, RunHealthCheckResponses, RunStorageGcData, RunStorageGcResponses, RunSubscriptionNowData, RunSubscriptionNowErrors, RunSubscriptionNowResponses, SamlAcsData, SamlAcsErrors, SamlLoginData, SamlLoginErrors, SendTestEmailData, SendTestEmailErrors, SendTestEmailResponses, SetArtifactLabelsData, SetArtifactLabelsErrors, SetArtifactLabelsResponses, SetCacheTtlData, SetCacheTtlErrors, SetCacheTtlResponses, SetLabelsData, SetLabelsErrors, SetLabelsResponses, SetReleaseTargetData, SetReleaseTargetErrors, SetReleaseTargetResponses, SetRepoLabelsData, SetRepoLabelsErrors, SetRepoLabelsResponses, SetRoutingRulesData, SetRoutingRulesErrors, SetRoutingRulesResponses, SetupStatusData, SetupStatusResponses, SetUpstreamAuthData, SetUpstreamAuthErrors, SetUpstreamAuthResponses, SetupTotpData, SetupTotpErrors, SetupTotpResponses, StartMigrationData, StartMigrationErrors, StartMigrationResponses, StatsData, StatsResponses, StreamMigrationProgressData, StreamMigrationProgressErrors, StreamMigrationProgressResponses, SubmitCrashesData, SubmitCrashesResponses, SuggestData, SuggestResponses, SuppressAlertData, SuppressAlertResponses, SuppressIssueData, SuppressIssueErrors, SuppressIssueResponses, TestConnectionData, TestConnectionErrors, TestConnectionResponses, TestFormatHandlerData, TestFormatHandlerResponses, TestLdapData, TestLdapErrors, TestLdapResponses, TestUpstreamData, TestUpstreamErrors, TestUpstreamResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, ToggleLdapData, ToggleLdapErrors, ToggleLdapResponses, ToggleOidcData, ToggleOidcErrors, ToggleOidcResponses, TogglePolicyData, TogglePolicyErrors, TogglePolicyResponses, ToggleSamlData, ToggleSamlErrors, ToggleSamlResponses, TrendingData, TrendingResponses, TriggerChecksData, TriggerChecksErrors, TriggerChecksResponses, TriggerReindexData, TriggerReindexErrors, TriggerReindexResponses, TriggerScanData, TriggerScanErrors, TriggerScanResponses, TriggerSearchReindexData, TriggerSearchReindexErrors, TriggerSearchReindexResponses, TriggerSyncData, TriggerSyncErrors, TriggerSyncResponses, UnassignRepoData, UnassignRepoErrors, UnassignRepoResponses, UninstallPluginData, UninstallPluginErrors, UninstallPluginResponses, UnregisterPeerData, UnregisterPeerErrors, UnregisterPeerResponses, UnsuppressIssueData, UnsuppressIssueErrors, UnsuppressIssueResponses, UpdateAnalysisData, UpdateAnalysisResponses, UpdateBuildData, UpdateBuildErrors, UpdateBuildResponses, UpdateChunkAvailabilityData, UpdateChunkAvailabilityResponses, UpdateCurationRuleData, UpdateCurationRuleResponses, UpdateCveStatusByArtifactCveData, UpdateCveStatusByArtifactCveErrors, UpdateCveStatusByArtifactCveResponses, UpdateCveStatusData, UpdateCveStatusErrors, UpdateCveStatusResponses, UpdateGateData, UpdateGateErrors, UpdateGateResponses, UpdateGroupData, UpdateGroupErrors, UpdateGroupResponses, UpdateLdapData, UpdateLdapErrors, UpdateLdapResponses, UpdateLifecyclePolicyData, UpdateLifecyclePolicyResponses, UpdateNetworkProfileData, UpdateNetworkProfileResponses, UpdateOidcData, UpdateOidcErrors, UpdateOidcResponses, UpdatePermissionData, UpdatePermissionErrors, UpdatePermissionResponses, UpdatePluginConfigData, UpdatePluginConfigErrors, UpdatePluginConfigResponses, UpdatePolicyData, UpdatePolicyErrors, UpdatePolicyResponses, UpdateRepoSecurityData, UpdateRepoSecurityErrors, UpdateRepoSecurityResponses, UpdateRepoSigningConfigData, UpdateRepoSigningConfigErrors, UpdateRepoSigningConfigResponses, UpdateRepositoryData, UpdateRepositoryErrors, UpdateRepositoryResponses, UpdateRuleData, UpdateRuleErrors, UpdateRuleResponses, UpdateSamlData, UpdateSamlErrors, UpdateSamlResponses, UpdateServiceAccountData, UpdateServiceAccountErrors, UpdateServiceAccountResponses, UpdateSettingsData, UpdateSettingsErrors, UpdateSettingsResponses, UpdateSyncPolicyData, UpdateSyncPolicyErrors, UpdateSyncPolicyResponses, UpdateTelemetrySettingsData, UpdateTelemetrySettingsResponses, UpdateUserData, UpdateUserErrors, UpdateUserResponses, UpdateVirtualMembersData, UpdateVirtualMembersErrors, UpdateVirtualMembersResponses, UploadArtifactData, UploadArtifactErrors, UploadArtifactResponses, UploadChunkData, UploadChunkErrors, UploadChunkResponses, UpsertLicensePolicyData, UpsertLicensePolicyErrors, UpsertLicensePolicyResponses, VerifyTotpData, VerifyTotpErrors, VerifyTotpResponses } from './types.gen';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
8
8
|
/**
|
|
@@ -292,7 +292,7 @@ export const getHealthLog = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
292
292
|
});
|
|
293
293
|
|
|
294
294
|
/**
|
|
295
|
-
* Trigger a full
|
|
295
|
+
* Trigger a full OpenSearch reindex of all artifacts and repositories.
|
|
296
296
|
*
|
|
297
297
|
* Requires admin privileges and Meilisearch to be configured.
|
|
298
298
|
*/
|
|
@@ -302,8 +302,18 @@ export const triggerReindex = <ThrowOnError extends boolean = false>(options?: O
|
|
|
302
302
|
...options
|
|
303
303
|
});
|
|
304
304
|
|
|
305
|
+
export const rescanForInventory = <ThrowOnError extends boolean = false>(options: Options<RescanForInventoryData, ThrowOnError>) => (options.client ?? client).post<RescanForInventoryResponses, RescanForInventoryErrors, ThrowOnError>({
|
|
306
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
307
|
+
url: '/api/v1/admin/rescan-for-inventory',
|
|
308
|
+
...options,
|
|
309
|
+
headers: {
|
|
310
|
+
'Content-Type': 'application/json',
|
|
311
|
+
...options.headers
|
|
312
|
+
}
|
|
313
|
+
});
|
|
314
|
+
|
|
305
315
|
/**
|
|
306
|
-
* Trigger a full reindex of all artifacts and repositories in
|
|
316
|
+
* Trigger a full reindex of all artifacts and repositories in OpenSearch.
|
|
307
317
|
*
|
|
308
318
|
* The reindex runs asynchronously in the background. The endpoint returns
|
|
309
319
|
* immediately with a confirmation that the task was started.
|
|
@@ -332,6 +342,22 @@ export const updateSettings = <ThrowOnError extends boolean = false>(options: Op
|
|
|
332
342
|
}
|
|
333
343
|
});
|
|
334
344
|
|
|
345
|
+
/**
|
|
346
|
+
* Send a test email to verify SMTP configuration.
|
|
347
|
+
*
|
|
348
|
+
* Requires admin privileges. Sends a short test message to the provided
|
|
349
|
+
* recipient address and reports whether delivery succeeded.
|
|
350
|
+
*/
|
|
351
|
+
export const sendTestEmail = <ThrowOnError extends boolean = false>(options: Options<SendTestEmailData, ThrowOnError>) => (options.client ?? client).post<SendTestEmailResponses, SendTestEmailErrors, ThrowOnError>({
|
|
352
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
353
|
+
url: '/api/v1/admin/smtp/test',
|
|
354
|
+
...options,
|
|
355
|
+
headers: {
|
|
356
|
+
'Content-Type': 'application/json',
|
|
357
|
+
...options.headers
|
|
358
|
+
}
|
|
359
|
+
});
|
|
360
|
+
|
|
335
361
|
/**
|
|
336
362
|
* List all LDAP provider configurations
|
|
337
363
|
*/
|
|
@@ -582,6 +608,21 @@ export const runStorageGc = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
582
608
|
}
|
|
583
609
|
});
|
|
584
610
|
|
|
611
|
+
/**
|
|
612
|
+
* GET /api/v1/admin/storage-gc/oci-blob-report
|
|
613
|
+
*
|
|
614
|
+
* Read-only report of the OCI blob (`oci_blobs`) storage footprint
|
|
615
|
+
* (issue #1408). Performs no deletion and takes no locks — it only runs
|
|
616
|
+
* aggregate `SELECT`s. Surfaces logical vs dedup-aware physical bytes so
|
|
617
|
+
* operators can see how much un-reclaimed blob storage exists before any
|
|
618
|
+
* garbage-collection sweep is enabled.
|
|
619
|
+
*/
|
|
620
|
+
export const ociBlobReport = <ThrowOnError extends boolean = false>(options?: Options<OciBlobReportData, ThrowOnError>) => (options?.client ?? client).get<OciBlobReportResponses, unknown, ThrowOnError>({
|
|
621
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
622
|
+
url: '/api/v1/admin/storage-gc/oci-blob-report',
|
|
623
|
+
...options
|
|
624
|
+
});
|
|
625
|
+
|
|
585
626
|
/**
|
|
586
627
|
* GET /api/v1/admin/telemetry/crashes
|
|
587
628
|
*/
|
|
@@ -797,7 +838,14 @@ export const login = <ThrowOnError extends boolean = false>(options: Options<Log
|
|
|
797
838
|
/**
|
|
798
839
|
* Logout current session
|
|
799
840
|
*/
|
|
800
|
-
export const logout = <ThrowOnError extends boolean = false>(options?: Options<LogoutData, ThrowOnError>) => (options?.client ?? client).post<LogoutResponses, unknown, ThrowOnError>({
|
|
841
|
+
export const logout = <ThrowOnError extends boolean = false>(options?: Options<LogoutData, ThrowOnError>) => (options?.client ?? client).post<LogoutResponses, unknown, ThrowOnError>({
|
|
842
|
+
url: '/api/v1/auth/logout',
|
|
843
|
+
...options,
|
|
844
|
+
headers: {
|
|
845
|
+
'Content-Type': 'application/json',
|
|
846
|
+
...options?.headers
|
|
847
|
+
}
|
|
848
|
+
});
|
|
801
849
|
|
|
802
850
|
/**
|
|
803
851
|
* Get current user info
|
|
@@ -1829,6 +1877,34 @@ export const unassignRepo = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1829
1877
|
...options
|
|
1830
1878
|
});
|
|
1831
1879
|
|
|
1880
|
+
/**
|
|
1881
|
+
* Get full subscription details for a (peer, repo) pair.
|
|
1882
|
+
*
|
|
1883
|
+
* Returns the per-subscription `replication_mode`, `replication_schedule`,
|
|
1884
|
+
* and `replication_filter` exactly as persisted by `POST /:id/repositories`.
|
|
1885
|
+
* Round-trips the filter so callers can verify that a scheduled-sync
|
|
1886
|
+
* filter (e.g. `{"include_patterns": ["\\.tar\\.gz$"]}`) was persisted.
|
|
1887
|
+
*/
|
|
1888
|
+
export const getSubscription = <ThrowOnError extends boolean = false>(options: Options<GetSubscriptionData, ThrowOnError>) => (options.client ?? client).get<GetSubscriptionResponses, GetSubscriptionErrors, ThrowOnError>({
|
|
1889
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1890
|
+
url: '/api/v1/peers/{id}/repositories/{repo_id}',
|
|
1891
|
+
...options
|
|
1892
|
+
});
|
|
1893
|
+
|
|
1894
|
+
/**
|
|
1895
|
+
* Trigger an immediate sync for a single (peer, repo) subscription.
|
|
1896
|
+
*
|
|
1897
|
+
* Queues one `sync_task` per artifact in the repository at priority 100
|
|
1898
|
+
* without waiting for the next cron tick. Idempotent: if tasks are already
|
|
1899
|
+
* pending for the same artifacts, the unique constraint
|
|
1900
|
+
* `(peer_instance_id, artifact_id, task_type)` skips duplicates.
|
|
1901
|
+
*/
|
|
1902
|
+
export const runSubscriptionNow = <ThrowOnError extends boolean = false>(options: Options<RunSubscriptionNowData, ThrowOnError>) => (options.client ?? client).post<RunSubscriptionNowResponses, RunSubscriptionNowErrors, ThrowOnError>({
|
|
1903
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
1904
|
+
url: '/api/v1/peers/{id}/repositories/{repo_id}/sync',
|
|
1905
|
+
...options
|
|
1906
|
+
});
|
|
1907
|
+
|
|
1832
1908
|
/**
|
|
1833
1909
|
* Trigger sync for peer instance
|
|
1834
1910
|
*/
|
|
@@ -2210,6 +2286,32 @@ export const promotionHistory = <ThrowOnError extends boolean = false>(options:
|
|
|
2210
2286
|
...options
|
|
2211
2287
|
});
|
|
2212
2288
|
|
|
2289
|
+
/**
|
|
2290
|
+
* Get the linked release target for a staging repository.
|
|
2291
|
+
*/
|
|
2292
|
+
export const getReleaseTarget = <ThrowOnError extends boolean = false>(options: Options<GetReleaseTargetData, ThrowOnError>) => (options.client ?? client).get<GetReleaseTargetResponses, GetReleaseTargetErrors, ThrowOnError>({
|
|
2293
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2294
|
+
url: '/api/v1/promotion/repositories/{key}/release-target',
|
|
2295
|
+
...options
|
|
2296
|
+
});
|
|
2297
|
+
|
|
2298
|
+
/**
|
|
2299
|
+
* Set or remove the linked release target for a staging repository.
|
|
2300
|
+
*
|
|
2301
|
+
* The release repository must exist, be type Local, and share the same package
|
|
2302
|
+
* format as the staging repository. Pass `null` for `release_repository_key` to
|
|
2303
|
+
* remove the link.
|
|
2304
|
+
*/
|
|
2305
|
+
export const setReleaseTarget = <ThrowOnError extends boolean = false>(options: Options<SetReleaseTargetData, ThrowOnError>) => (options.client ?? client).put<SetReleaseTargetResponses, SetReleaseTargetErrors, ThrowOnError>({
|
|
2306
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2307
|
+
url: '/api/v1/promotion/repositories/{key}/release-target',
|
|
2308
|
+
...options,
|
|
2309
|
+
headers: {
|
|
2310
|
+
'Content-Type': 'application/json',
|
|
2311
|
+
...options.headers
|
|
2312
|
+
}
|
|
2313
|
+
});
|
|
2314
|
+
|
|
2213
2315
|
export const listChecks = <ThrowOnError extends boolean = false>(options?: Options<ListChecksData, ThrowOnError>) => (options?.client ?? client).get<ListChecksResponses, unknown, ThrowOnError>({
|
|
2214
2316
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2215
2317
|
url: '/api/v1/quality/checks',
|
|
@@ -2316,6 +2418,37 @@ export const suppressIssue = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2316
2418
|
}
|
|
2317
2419
|
});
|
|
2318
2420
|
|
|
2421
|
+
/**
|
|
2422
|
+
* Get quarantine status for an artifact
|
|
2423
|
+
*/
|
|
2424
|
+
export const getQuarantineStatus = <ThrowOnError extends boolean = false>(options: Options<GetQuarantineStatusData, ThrowOnError>) => (options.client ?? client).get<GetQuarantineStatusResponses, GetQuarantineStatusErrors, ThrowOnError>({
|
|
2425
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2426
|
+
url: '/api/v1/quarantine/{artifact_id}',
|
|
2427
|
+
...options
|
|
2428
|
+
});
|
|
2429
|
+
|
|
2430
|
+
/**
|
|
2431
|
+
* Reject a quarantined artifact (admin only)
|
|
2432
|
+
*/
|
|
2433
|
+
export const rejectQuarantinedArtifact = <ThrowOnError extends boolean = false>(options: Options<RejectQuarantinedArtifactData, ThrowOnError>) => (options.client ?? client).post<RejectQuarantinedArtifactResponses, RejectQuarantinedArtifactErrors, ThrowOnError>({
|
|
2434
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2435
|
+
url: '/api/v1/quarantine/{artifact_id}/reject',
|
|
2436
|
+
...options,
|
|
2437
|
+
headers: {
|
|
2438
|
+
'Content-Type': 'application/json',
|
|
2439
|
+
...options.headers
|
|
2440
|
+
}
|
|
2441
|
+
});
|
|
2442
|
+
|
|
2443
|
+
/**
|
|
2444
|
+
* Release an artifact from quarantine (admin only)
|
|
2445
|
+
*/
|
|
2446
|
+
export const releaseArtifact = <ThrowOnError extends boolean = false>(options: Options<ReleaseArtifactData, ThrowOnError>) => (options.client ?? client).post<ReleaseArtifactResponses, ReleaseArtifactErrors, ThrowOnError>({
|
|
2447
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2448
|
+
url: '/api/v1/quarantine/{artifact_id}/release',
|
|
2449
|
+
...options
|
|
2450
|
+
});
|
|
2451
|
+
|
|
2319
2452
|
/**
|
|
2320
2453
|
* List repositories
|
|
2321
2454
|
*/
|
|
@@ -2412,11 +2545,57 @@ export const setCacheTtl = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
2412
2545
|
}
|
|
2413
2546
|
});
|
|
2414
2547
|
|
|
2548
|
+
/**
|
|
2549
|
+
* Invalidate a single cached artifact entry on a Remote (proxy) repository
|
|
2550
|
+
* (#1539).
|
|
2551
|
+
*
|
|
2552
|
+
* Mirrors the auth + repo-access pattern of `set_cache_ttl`. Idempotent:
|
|
2553
|
+
* invalidating a path that was never cached (or was already evicted) still
|
|
2554
|
+
* returns 200, matching the underlying `ProxyService::invalidate_cache`
|
|
2555
|
+
* contract (which ignores delete-of-missing on the storage backend).
|
|
2556
|
+
*/
|
|
2557
|
+
export const invalidateCache = <ThrowOnError extends boolean = false>(options: Options<InvalidateCacheData, ThrowOnError>) => (options.client ?? client).post<InvalidateCacheResponses, InvalidateCacheErrors, ThrowOnError>({
|
|
2558
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2559
|
+
url: '/api/v1/repositories/{key}/cache/invalidate',
|
|
2560
|
+
...options
|
|
2561
|
+
});
|
|
2562
|
+
|
|
2415
2563
|
/**
|
|
2416
2564
|
* Download artifact
|
|
2417
2565
|
*/
|
|
2418
2566
|
export const downloadArtifact = <ThrowOnError extends boolean = false>(options: Options<DownloadArtifactData, ThrowOnError>) => (options.client ?? client).get<DownloadArtifactResponses, DownloadArtifactErrors, ThrowOnError>({ url: '/api/v1/repositories/{key}/download/{path}', ...options });
|
|
2419
2567
|
|
|
2568
|
+
/**
|
|
2569
|
+
* List the email subscriptions configured on a repository.
|
|
2570
|
+
*/
|
|
2571
|
+
export const listSubscriptions = <ThrowOnError extends boolean = false>(options: Options<ListSubscriptionsData, ThrowOnError>) => (options.client ?? client).get<ListSubscriptionsResponses, ListSubscriptionsErrors, ThrowOnError>({
|
|
2572
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2573
|
+
url: '/api/v1/repositories/{key}/email-subscriptions',
|
|
2574
|
+
...options
|
|
2575
|
+
});
|
|
2576
|
+
|
|
2577
|
+
/**
|
|
2578
|
+
* Create an email subscription scoped to a repository.
|
|
2579
|
+
*/
|
|
2580
|
+
export const createSubscription = <ThrowOnError extends boolean = false>(options: Options<CreateSubscriptionData, ThrowOnError>) => (options.client ?? client).post<CreateSubscriptionResponses, CreateSubscriptionErrors, ThrowOnError>({
|
|
2581
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2582
|
+
url: '/api/v1/repositories/{key}/email-subscriptions',
|
|
2583
|
+
...options,
|
|
2584
|
+
headers: {
|
|
2585
|
+
'Content-Type': 'application/json',
|
|
2586
|
+
...options.headers
|
|
2587
|
+
}
|
|
2588
|
+
});
|
|
2589
|
+
|
|
2590
|
+
/**
|
|
2591
|
+
* Delete an email subscription by id.
|
|
2592
|
+
*/
|
|
2593
|
+
export const deleteSubscription = <ThrowOnError extends boolean = false>(options: Options<DeleteSubscriptionData, ThrowOnError>) => (options.client ?? client).delete<DeleteSubscriptionResponses, DeleteSubscriptionErrors, ThrowOnError>({
|
|
2594
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2595
|
+
url: '/api/v1/repositories/{key}/email-subscriptions/{subscription_id}',
|
|
2596
|
+
...options
|
|
2597
|
+
});
|
|
2598
|
+
|
|
2420
2599
|
/**
|
|
2421
2600
|
* List all labels on a repository
|
|
2422
2601
|
*/
|
|
@@ -2464,7 +2643,11 @@ export const addRepoLabel = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
2464
2643
|
/**
|
|
2465
2644
|
* List virtual repository members
|
|
2466
2645
|
*/
|
|
2467
|
-
export const listVirtualMembers = <ThrowOnError extends boolean = false>(options: Options<ListVirtualMembersData, ThrowOnError>) => (options.client ?? client).get<ListVirtualMembersResponses, ListVirtualMembersErrors, ThrowOnError>({
|
|
2646
|
+
export const listVirtualMembers = <ThrowOnError extends boolean = false>(options: Options<ListVirtualMembersData, ThrowOnError>) => (options.client ?? client).get<ListVirtualMembersResponses, ListVirtualMembersErrors, ThrowOnError>({
|
|
2647
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2648
|
+
url: '/api/v1/repositories/{key}/members',
|
|
2649
|
+
...options
|
|
2650
|
+
});
|
|
2468
2651
|
|
|
2469
2652
|
/**
|
|
2470
2653
|
* Add a member to a virtual repository
|
|
@@ -2501,6 +2684,68 @@ export const removeVirtualMember = <ThrowOnError extends boolean = false>(option
|
|
|
2501
2684
|
...options
|
|
2502
2685
|
});
|
|
2503
2686
|
|
|
2687
|
+
/**
|
|
2688
|
+
* List the PEP 708 `tracks` declarations on a repository.
|
|
2689
|
+
*/
|
|
2690
|
+
export const listPypiTracks = <ThrowOnError extends boolean = false>(options: Options<ListPypiTracksData, ThrowOnError>) => (options.client ?? client).get<ListPypiTracksResponses, ListPypiTracksErrors, ThrowOnError>({ url: '/api/v1/repositories/{key}/pypi-tracks', ...options });
|
|
2691
|
+
|
|
2692
|
+
/**
|
|
2693
|
+
* Remove a PEP 708 `tracks` declaration, restoring local-precedence isolation
|
|
2694
|
+
* for that project name (#1600).
|
|
2695
|
+
*/
|
|
2696
|
+
export const deletePypiTrack = <ThrowOnError extends boolean = false>(options: Options<DeletePypiTrackData, ThrowOnError>) => (options.client ?? client).delete<DeletePypiTrackResponses, DeletePypiTrackErrors, ThrowOnError>({
|
|
2697
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2698
|
+
url: '/api/v1/repositories/{key}/pypi-tracks/{project}',
|
|
2699
|
+
...options
|
|
2700
|
+
});
|
|
2701
|
+
|
|
2702
|
+
/**
|
|
2703
|
+
* Declare (upsert) that a locally-owned PyPI project tracks an upstream one,
|
|
2704
|
+
* allowing a virtual repository to merge versions across members for that name
|
|
2705
|
+
* instead of isolating it (PEP 708, #1600).
|
|
2706
|
+
*/
|
|
2707
|
+
export const putPypiTrack = <ThrowOnError extends boolean = false>(options: Options<PutPypiTrackData, ThrowOnError>) => (options.client ?? client).put<PutPypiTrackResponses, PutPypiTrackErrors, ThrowOnError>({
|
|
2708
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2709
|
+
url: '/api/v1/repositories/{key}/pypi-tracks/{project}',
|
|
2710
|
+
...options,
|
|
2711
|
+
headers: {
|
|
2712
|
+
'Content-Type': 'application/json',
|
|
2713
|
+
...options.headers
|
|
2714
|
+
}
|
|
2715
|
+
});
|
|
2716
|
+
|
|
2717
|
+
/**
|
|
2718
|
+
* Delete all routing rules for a repository
|
|
2719
|
+
*/
|
|
2720
|
+
export const deleteRoutingRules = <ThrowOnError extends boolean = false>(options: Options<DeleteRoutingRulesData, ThrowOnError>) => (options.client ?? client).delete<DeleteRoutingRulesResponses, DeleteRoutingRulesErrors, ThrowOnError>({
|
|
2721
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2722
|
+
url: '/api/v1/repositories/{key}/routing-rules',
|
|
2723
|
+
...options
|
|
2724
|
+
});
|
|
2725
|
+
|
|
2726
|
+
/**
|
|
2727
|
+
* Get routing rules for a repository
|
|
2728
|
+
*/
|
|
2729
|
+
export const getRoutingRules = <ThrowOnError extends boolean = false>(options: Options<GetRoutingRulesData, ThrowOnError>) => (options.client ?? client).get<GetRoutingRulesResponses, GetRoutingRulesErrors, ThrowOnError>({ url: '/api/v1/repositories/{key}/routing-rules', ...options });
|
|
2730
|
+
|
|
2731
|
+
/**
|
|
2732
|
+
* Set routing rules for a repository
|
|
2733
|
+
*
|
|
2734
|
+
* Routing rules rewrite the request path before it is forwarded to the
|
|
2735
|
+
* upstream server. This is useful for proxying resources like GitHub Releases
|
|
2736
|
+
* where the client-facing path structure differs from the upstream URL
|
|
2737
|
+
* layout. Rules are evaluated in order and the first match wins.
|
|
2738
|
+
*/
|
|
2739
|
+
export const setRoutingRules = <ThrowOnError extends boolean = false>(options: Options<SetRoutingRulesData, ThrowOnError>) => (options.client ?? client).post<SetRoutingRulesResponses, SetRoutingRulesErrors, ThrowOnError>({
|
|
2740
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2741
|
+
url: '/api/v1/repositories/{key}/routing-rules',
|
|
2742
|
+
...options,
|
|
2743
|
+
headers: {
|
|
2744
|
+
'Content-Type': 'application/json',
|
|
2745
|
+
...options.headers
|
|
2746
|
+
}
|
|
2747
|
+
});
|
|
2748
|
+
|
|
2504
2749
|
export const getRepoSecurity = <ThrowOnError extends boolean = false>(options: Options<GetRepoSecurityData, ThrowOnError>) => (options.client ?? client).get<GetRepoSecurityResponses, GetRepoSecurityErrors, ThrowOnError>({
|
|
2505
2750
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2506
2751
|
url: '/api/v1/repositories/{key}/security',
|
|
@@ -2532,6 +2777,52 @@ export const testUpstream = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
2532
2777
|
...options
|
|
2533
2778
|
});
|
|
2534
2779
|
|
|
2780
|
+
/**
|
|
2781
|
+
* List all access tokens configured on a repository.
|
|
2782
|
+
*/
|
|
2783
|
+
export const listRepoTokens = <ThrowOnError extends boolean = false>(options: Options<ListRepoTokensData, ThrowOnError>) => (options.client ?? client).get<ListRepoTokensResponses, ListRepoTokensErrors, ThrowOnError>({
|
|
2784
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2785
|
+
url: '/api/v1/repositories/{key}/tokens',
|
|
2786
|
+
...options
|
|
2787
|
+
});
|
|
2788
|
+
|
|
2789
|
+
/**
|
|
2790
|
+
* Create a new access token scoped to a repository.
|
|
2791
|
+
*
|
|
2792
|
+
* The token is automatically restricted to this repository. The plaintext
|
|
2793
|
+
* token value is returned only in this response and cannot be retrieved later.
|
|
2794
|
+
*/
|
|
2795
|
+
export const createRepoToken = <ThrowOnError extends boolean = false>(options: Options<CreateRepoTokenData, ThrowOnError>) => (options.client ?? client).post<CreateRepoTokenResponses, CreateRepoTokenErrors, ThrowOnError>({
|
|
2796
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2797
|
+
url: '/api/v1/repositories/{key}/tokens',
|
|
2798
|
+
...options,
|
|
2799
|
+
headers: {
|
|
2800
|
+
'Content-Type': 'application/json',
|
|
2801
|
+
...options.headers
|
|
2802
|
+
}
|
|
2803
|
+
});
|
|
2804
|
+
|
|
2805
|
+
/**
|
|
2806
|
+
* Revoke an access token from a repository.
|
|
2807
|
+
*
|
|
2808
|
+
* This soft-revokes the token by setting `revoked_at`. The token will
|
|
2809
|
+
* immediately stop working for authentication.
|
|
2810
|
+
*/
|
|
2811
|
+
export const revokeRepoToken = <ThrowOnError extends boolean = false>(options: Options<RevokeRepoTokenData, ThrowOnError>) => (options.client ?? client).delete<RevokeRepoTokenResponses, RevokeRepoTokenErrors, ThrowOnError>({
|
|
2812
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2813
|
+
url: '/api/v1/repositories/{key}/tokens/{token_id}',
|
|
2814
|
+
...options
|
|
2815
|
+
});
|
|
2816
|
+
|
|
2817
|
+
/**
|
|
2818
|
+
* Get details of a specific token on a repository.
|
|
2819
|
+
*/
|
|
2820
|
+
export const getRepoToken = <ThrowOnError extends boolean = false>(options: Options<GetRepoTokenData, ThrowOnError>) => (options.client ?? client).get<GetRepoTokenResponses, GetRepoTokenErrors, ThrowOnError>({
|
|
2821
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2822
|
+
url: '/api/v1/repositories/{key}/tokens/{token_id}',
|
|
2823
|
+
...options
|
|
2824
|
+
});
|
|
2825
|
+
|
|
2535
2826
|
/**
|
|
2536
2827
|
* Set or remove upstream auth for a remote repository
|
|
2537
2828
|
*/
|
|
@@ -2590,14 +2881,92 @@ export const checkLicenseCompliance = <ThrowOnError extends boolean = false>(opt
|
|
|
2590
2881
|
});
|
|
2591
2882
|
|
|
2592
2883
|
/**
|
|
2593
|
-
* Get CVE history for
|
|
2884
|
+
* Get CVE history for one artifact (typed UUID variant).
|
|
2885
|
+
*
|
|
2886
|
+
* Canonical replacement for the UUID branch of the overloaded
|
|
2887
|
+
* `/cve/history/{id}` route. Returns every CVE ever detected against the
|
|
2888
|
+
* given artifact, deduped across curated `cve_history` rows and live
|
|
2889
|
+
* `scan_findings` projections.
|
|
2890
|
+
*/
|
|
2891
|
+
export const getCveHistoryByArtifact = <ThrowOnError extends boolean = false>(options: Options<GetCveHistoryByArtifactData, ThrowOnError>) => (options.client ?? client).get<GetCveHistoryByArtifactResponses, GetCveHistoryByArtifactErrors, ThrowOnError>({
|
|
2892
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2893
|
+
url: '/api/v1/sbom/cve/history/by-artifact/{artifact_id}',
|
|
2894
|
+
...options
|
|
2895
|
+
});
|
|
2896
|
+
|
|
2897
|
+
/**
|
|
2898
|
+
* Get CVE history for one CVE identifier across artifacts (typed CVE-id
|
|
2899
|
+
* variant).
|
|
2900
|
+
*
|
|
2901
|
+
* Canonical replacement for the CVE-id branch of the overloaded
|
|
2902
|
+
* `/cve/history/{id}` route. Returns every artifact the caller can access
|
|
2903
|
+
* where the given CVE has been detected.
|
|
2594
2904
|
*/
|
|
2595
|
-
export const
|
|
2905
|
+
export const getCveHistoryByCve = <ThrowOnError extends boolean = false>(options: Options<GetCveHistoryByCveData, ThrowOnError>) => (options.client ?? client).get<GetCveHistoryByCveResponses, GetCveHistoryByCveErrors, ThrowOnError>({
|
|
2596
2906
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2597
|
-
url: '/api/v1/sbom/cve/history/{
|
|
2907
|
+
url: '/api/v1/sbom/cve/history/by-cve/{cve_id}',
|
|
2598
2908
|
...options
|
|
2599
2909
|
});
|
|
2600
2910
|
|
|
2911
|
+
/**
|
|
2912
|
+
* Get CVE history by artifact UUID or CVE identifier (legacy overload).
|
|
2913
|
+
*
|
|
2914
|
+
* The path param accepts either:
|
|
2915
|
+
* - A UUID `artifact_id` (legacy shape, returns all CVEs for one artifact)
|
|
2916
|
+
* - A CVE id like `CVE-2019-10744` (returns this CVE across every artifact
|
|
2917
|
+
* the caller can access)
|
|
2918
|
+
*
|
|
2919
|
+
* # URL design decision (#1385 round-2)
|
|
2920
|
+
*
|
|
2921
|
+
* Overloading a single `{id}` path parameter to mean two different lookups
|
|
2922
|
+
* is a REST anti-pattern: the route's behavior changes based on a runtime
|
|
2923
|
+
* content sniff. We considered splitting into two routes vs documenting the
|
|
2924
|
+
* overload and chose **both**: the split routes
|
|
2925
|
+
* `GET /cve/history/by-artifact/{uuid}` and `GET /cve/history/by-cve/{cve_id}`
|
|
2926
|
+
* are the canonical shape for new clients (typed path params, no sniff),
|
|
2927
|
+
* while this overload remains so the v1.2.0 SDKs that already shipped
|
|
2928
|
+
* against the single-route shape keep working. New code should prefer the
|
|
2929
|
+
* split routes; the overload may be deprecated in v1.3.
|
|
2930
|
+
*
|
|
2931
|
+
* Issue #1375: prior to this fix the route was typed `Path<Uuid>`, so any
|
|
2932
|
+
* CVE-id call (e.g. the release-gate `GET /sbom/cve/history/CVE-2019-10744`)
|
|
2933
|
+
* failed Axum's path extractor with a bare HTTP 400, leaving consumers
|
|
2934
|
+
* unable to look up history by CVE.
|
|
2935
|
+
*/
|
|
2936
|
+
export const getCveHistory = <ThrowOnError extends boolean = false>(options: Options<GetCveHistoryData, ThrowOnError>) => (options.client ?? client).get<GetCveHistoryResponses, GetCveHistoryErrors, ThrowOnError>({
|
|
2937
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2938
|
+
url: '/api/v1/sbom/cve/history/{id}',
|
|
2939
|
+
...options
|
|
2940
|
+
});
|
|
2941
|
+
|
|
2942
|
+
/**
|
|
2943
|
+
* Update CVE status for a synth (scan_findings-derived) Security tab row.
|
|
2944
|
+
*
|
|
2945
|
+
* Background (#1426): the Security tab read path projects `scan_findings`
|
|
2946
|
+
* into `CveHistoryEntry` rows whose `id` is a deterministic SHA-256 hash
|
|
2947
|
+
* (see `synth_cve_id`). Those ids have no corresponding row in the
|
|
2948
|
+
* `cve_history` table, so calls to `POST /cve/status/{id}` always 404 -- a
|
|
2949
|
+
* dead acknowledge path. This route operates on the only stable identity a
|
|
2950
|
+
* synth row carries, the (artifact_id, cve_id) pair, and writes the
|
|
2951
|
+
* underlying `scan_findings` rows instead.
|
|
2952
|
+
*
|
|
2953
|
+
* The wider design choice between (A) populating `cve_history` from the
|
|
2954
|
+
* scanner loop and (B) treating `scan_findings` as the source of truth for
|
|
2955
|
+
* the Security tab is settled here in favour of B: less code, less risk of
|
|
2956
|
+
* data drift between two parallel tables, and `cve_history` remains in
|
|
2957
|
+
* place for the rare curated/admin write path via the legacy
|
|
2958
|
+
* `POST /cve/status/{id}` route.
|
|
2959
|
+
*/
|
|
2960
|
+
export const updateCveStatusByArtifactCve = <ThrowOnError extends boolean = false>(options: Options<UpdateCveStatusByArtifactCveData, ThrowOnError>) => (options.client ?? client).post<UpdateCveStatusByArtifactCveResponses, UpdateCveStatusByArtifactCveErrors, ThrowOnError>({
|
|
2961
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2962
|
+
url: '/api/v1/sbom/cve/status/by-artifact/{artifact_id}/by-cve/{cve_id}',
|
|
2963
|
+
...options,
|
|
2964
|
+
headers: {
|
|
2965
|
+
'Content-Type': 'application/json',
|
|
2966
|
+
...options.headers
|
|
2967
|
+
}
|
|
2968
|
+
});
|
|
2969
|
+
|
|
2601
2970
|
/**
|
|
2602
2971
|
* Update CVE status
|
|
2603
2972
|
*/
|
|
@@ -2689,6 +3058,17 @@ export const getSbomComponents = <ThrowOnError extends boolean = false>(options:
|
|
|
2689
3058
|
|
|
2690
3059
|
/**
|
|
2691
3060
|
* Convert an SBOM to a different format
|
|
3061
|
+
*
|
|
3062
|
+
* Returns the converted SBOM as a [`SbomContentResponse`]: the metadata
|
|
3063
|
+
* row plus the full converted document under `content`. The `content` is
|
|
3064
|
+
* load-bearing here. A consumer that asked for `target_format=spdx` needs
|
|
3065
|
+
* the SPDX document (`content.spdxVersion`, `content.SPDXID`, ...) to feed
|
|
3066
|
+
* downstream attestation tooling, and a `target_format=cyclonedx` request
|
|
3067
|
+
* needs `content.bomFormat == "CycloneDX"`. Returning metadata-only
|
|
3068
|
+
* (`SbomResponse`) dropped the converted document entirely, so callers
|
|
3069
|
+
* could not tell an SPDX result from a CycloneDX one and round-trip
|
|
3070
|
+
* conversion appeared to lose the document shape. (release-gate
|
|
3071
|
+
* `test-sbom-convert.sh` 2.5.a / 2.5.b.)
|
|
2692
3072
|
*/
|
|
2693
3073
|
export const convertSbom = <ThrowOnError extends boolean = false>(options: Options<ConvertSbomData, ThrowOnError>) => (options.client ?? client).post<ConvertSbomResponses, ConvertSbomErrors, ThrowOnError>({
|
|
2694
3074
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -2724,7 +3104,7 @@ export const listScanConfigs = <ThrowOnError extends boolean = false>(options?:
|
|
|
2724
3104
|
...options
|
|
2725
3105
|
});
|
|
2726
3106
|
|
|
2727
|
-
export const getDashboard = <ThrowOnError extends boolean = false>(options?: Options<GetDashboardData, ThrowOnError>) => (options?.client ?? client).get<GetDashboardResponses,
|
|
3107
|
+
export const getDashboard = <ThrowOnError extends boolean = false>(options?: Options<GetDashboardData, ThrowOnError>) => (options?.client ?? client).get<GetDashboardResponses, GetDashboardErrors, ThrowOnError>({
|
|
2728
3108
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2729
3109
|
url: '/api/v1/security/dashboard',
|
|
2730
3110
|
...options
|
|
@@ -2812,7 +3192,7 @@ export const listFindings = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
2812
3192
|
...options
|
|
2813
3193
|
});
|
|
2814
3194
|
|
|
2815
|
-
export const getAllScores = <ThrowOnError extends boolean = false>(options?: Options<GetAllScoresData, ThrowOnError>) => (options?.client ?? client).get<GetAllScoresResponses,
|
|
3195
|
+
export const getAllScores = <ThrowOnError extends boolean = false>(options?: Options<GetAllScoresData, ThrowOnError>) => (options?.client ?? client).get<GetAllScoresResponses, GetAllScoresErrors, ThrowOnError>({
|
|
2816
3196
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
2817
3197
|
url: '/api/v1/security/scores',
|
|
2818
3198
|
...options
|
|
@@ -3109,6 +3489,16 @@ export const togglePolicy = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
3109
3489
|
}
|
|
3110
3490
|
});
|
|
3111
3491
|
|
|
3492
|
+
/**
|
|
3493
|
+
* Return public runtime configuration.
|
|
3494
|
+
*
|
|
3495
|
+
* No authentication required. This endpoint exposes only non-sensitive
|
|
3496
|
+
* configuration values that help frontends adapt their behavior (e.g.
|
|
3497
|
+
* showing upload limits, conditionally rendering scanner UI, initiating
|
|
3498
|
+
* OIDC flows).
|
|
3499
|
+
*/
|
|
3500
|
+
export const getSystemConfig = <ThrowOnError extends boolean = false>(options?: Options<GetSystemConfigData, ThrowOnError>) => (options?.client ?? client).get<GetSystemConfigResponses, unknown, ThrowOnError>({ url: '/api/v1/system/config', ...options });
|
|
3501
|
+
|
|
3112
3502
|
export const getTree = <ThrowOnError extends boolean = false>(options?: Options<GetTreeData, ThrowOnError>) => (options?.client ?? client).get<GetTreeResponses, GetTreeErrors, ThrowOnError>({
|
|
3113
3503
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3114
3504
|
url: '/api/v1/tree',
|
|
@@ -3208,6 +3598,17 @@ export const updateUser = <ThrowOnError extends boolean = false>(options: Option
|
|
|
3208
3598
|
}
|
|
3209
3599
|
});
|
|
3210
3600
|
|
|
3601
|
+
/**
|
|
3602
|
+
* Force a user to change their password on next login (admin only).
|
|
3603
|
+
* Sets must_change_password=true and invalidates existing sessions so the
|
|
3604
|
+
* user is prompted immediately on their next login.
|
|
3605
|
+
*/
|
|
3606
|
+
export const forcePasswordChange = <ThrowOnError extends boolean = false>(options: Options<ForcePasswordChangeData, ThrowOnError>) => (options.client ?? client).post<ForcePasswordChangeResponses, ForcePasswordChangeErrors, ThrowOnError>({
|
|
3607
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3608
|
+
url: '/api/v1/users/{id}/force-password-change',
|
|
3609
|
+
...options
|
|
3610
|
+
});
|
|
3611
|
+
|
|
3211
3612
|
/**
|
|
3212
3613
|
* Change user password
|
|
3213
3614
|
*/
|
|
@@ -3303,7 +3704,12 @@ export const listWebhooks = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
3303
3704
|
});
|
|
3304
3705
|
|
|
3305
3706
|
/**
|
|
3306
|
-
* Create webhook
|
|
3707
|
+
* Create webhook.
|
|
3708
|
+
*
|
|
3709
|
+
* Generates a fresh signing secret (or accepts a caller-supplied one),
|
|
3710
|
+
* encrypts it at rest, and returns the raw secret in the response body
|
|
3711
|
+
* **once**. After this call, GET on the webhook returns only
|
|
3712
|
+
* `secret_digest`, never the raw secret.
|
|
3307
3713
|
*/
|
|
3308
3714
|
export const createWebhook = <ThrowOnError extends boolean = false>(options: Options<CreateWebhookData, ThrowOnError>) => (options.client ?? client).post<CreateWebhookResponses, CreateWebhookErrors, ThrowOnError>({
|
|
3309
3715
|
security: [{ scheme: 'bearer', type: 'http' }],
|
|
@@ -3369,6 +3775,29 @@ export const enableWebhook = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
3369
3775
|
...options
|
|
3370
3776
|
});
|
|
3371
3777
|
|
|
3778
|
+
/**
|
|
3779
|
+
* Rotate the signing secret for a webhook.
|
|
3780
|
+
*
|
|
3781
|
+
* Generates a new raw secret, encrypts it, moves the existing
|
|
3782
|
+
* `secret_encrypted` into `secret_previous_encrypted`, and stamps an
|
|
3783
|
+
* expiry 24 hours in the future. The new raw secret is returned in the
|
|
3784
|
+
* response body **once**. The HMAC signing path (added in a later ticket)
|
|
3785
|
+
* signs deliveries with both secrets while the previous one is within
|
|
3786
|
+
* its expiry window so consumers can rotate without dropped events.
|
|
3787
|
+
*
|
|
3788
|
+
* If a previous-secret window is still active when the rotate request
|
|
3789
|
+
* arrives, the request is REJECTED with HTTP 409 Conflict. This prevents
|
|
3790
|
+
* two near-simultaneous rotations from clobbering the original
|
|
3791
|
+
* `secret_previous_encrypted` material before the operator has finished
|
|
3792
|
+
* distributing the previous new key. The 409 body is structured:
|
|
3793
|
+
* `{"error": "rotation_already_in_progress", "expires_at": "<RFC3339>"}`.
|
|
3794
|
+
*/
|
|
3795
|
+
export const rotateWebhookSecret = <ThrowOnError extends boolean = false>(options: Options<RotateWebhookSecretData, ThrowOnError>) => (options.client ?? client).post<RotateWebhookSecretResponses, RotateWebhookSecretErrors, ThrowOnError>({
|
|
3796
|
+
security: [{ scheme: 'bearer', type: 'http' }],
|
|
3797
|
+
url: '/api/v1/webhooks/{id}/rotate-secret',
|
|
3798
|
+
...options
|
|
3799
|
+
});
|
|
3800
|
+
|
|
3372
3801
|
/**
|
|
3373
3802
|
* Test webhook by sending a test payload
|
|
3374
3803
|
*/
|
|
@@ -3379,15 +3808,15 @@ export const testWebhook = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
3379
3808
|
});
|
|
3380
3809
|
|
|
3381
3810
|
/**
|
|
3382
|
-
* Health check endpoint
|
|
3811
|
+
* Health check endpoint -- rich status page for dashboards.
|
|
3383
3812
|
*
|
|
3384
3813
|
* Checks database, storage (real write/read probe), optional services (Trivy,
|
|
3385
|
-
*
|
|
3814
|
+
* OpenSearch), and exposes DB connection pool statistics.
|
|
3386
3815
|
*/
|
|
3387
3816
|
export const healthCheck = <ThrowOnError extends boolean = false>(options?: Options<HealthCheckData, ThrowOnError>) => (options?.client ?? client).get<HealthCheckResponses, HealthCheckErrors, ThrowOnError>({ url: '/health', ...options });
|
|
3388
3817
|
|
|
3389
3818
|
/**
|
|
3390
|
-
* Liveness probe
|
|
3819
|
+
* Liveness probe - confirms the process is alive and can serve HTTP.
|
|
3391
3820
|
*
|
|
3392
3821
|
* Takes no State parameter. If Axum can route the request and execute this
|
|
3393
3822
|
* function, the process is alive. External service failures cannot trigger
|
|
@@ -3396,9 +3825,17 @@ export const healthCheck = <ThrowOnError extends boolean = false>(options?: Opti
|
|
|
3396
3825
|
export const livenessCheck = <ThrowOnError extends boolean = false>(options?: Options<LivenessCheckData, ThrowOnError>) => (options?.client ?? client).get<LivenessCheckResponses, unknown, ThrowOnError>({ url: '/livez', ...options });
|
|
3397
3826
|
|
|
3398
3827
|
/**
|
|
3399
|
-
* Readiness probe
|
|
3828
|
+
* Readiness probe - is the service ready to accept traffic?
|
|
3829
|
+
*
|
|
3830
|
+
* Returns 200 once the database is reachable and migrations have applied
|
|
3831
|
+
* successfully. Initial-setup state (whether the default admin password has
|
|
3832
|
+
* been changed) is reported as an informational field on the response but
|
|
3833
|
+
* does NOT influence the status code: a 503 here would make Kubernetes
|
|
3834
|
+
* restart the pod, terminating any `kubectl exec` session an operator is
|
|
3835
|
+
* using to complete setup. See issue #889.
|
|
3400
3836
|
*
|
|
3401
|
-
*
|
|
3402
|
-
*
|
|
3837
|
+
* API mutations are separately gated by the setup middleware
|
|
3838
|
+
* (`api::middleware::setup`) until setup is complete, so a 200 from this
|
|
3839
|
+
* endpoint does not imply that write traffic will be accepted.
|
|
3403
3840
|
*/
|
|
3404
3841
|
export const readinessCheck = <ThrowOnError extends boolean = false>(options?: Options<ReadinessCheckData, ThrowOnError>) => (options?.client ?? client).get<ReadinessCheckResponses, ReadinessCheckErrors, ThrowOnError>({ url: '/readyz', ...options });
|