@harnessio/react-har-service-client 0.99.0 → 0.100.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/har-service/src/services/hooks/useCreateRegistryV3Mutation.d.ts +24 -0
- package/dist/har-service/src/services/hooks/useCreateRegistryV3Mutation.js +15 -0
- package/dist/har-service/src/services/hooks/useGetRegistryV3Query.d.ts +24 -0
- package/dist/har-service/src/services/hooks/useGetRegistryV3Query.js +15 -0
- package/dist/har-service/src/services/hooks/useListTreeRootsV3Query.d.ts +1 -2
- package/dist/har-service/src/services/hooks/useRebuildRegistryIndexV3Mutation.d.ts +1 -1
- package/dist/har-service/src/services/hooks/useRebuildRegistryIndexV3Mutation.js +1 -1
- package/dist/har-service/src/services/hooks/useResolveTreePathV3Query.d.ts +2 -2
- package/dist/har-service/src/services/hooks/useResolveTreePathV3Query.js +1 -1
- package/dist/har-service/src/services/hooks/useSearchTreeV3Query.d.ts +5 -2
- package/dist/har-service/src/services/hooks/useSearchTreeV3Query.js +4 -1
- package/dist/har-service/src/services/index.d.ts +21 -0
- package/dist/har-service/src/services/index.js +2 -0
- package/dist/har-service/src/services/requestBodies/RegistryCreateRequestV3RequestBody.d.ts +2 -0
- package/dist/har-service/src/services/requestBodies/RegistryCreateRequestV3RequestBody.js +1 -0
- package/dist/har-service/src/services/responses/RegistryResponseV3Response.d.ts +2 -0
- package/dist/har-service/src/services/responses/RegistryResponseV3Response.js +1 -0
- package/dist/har-service/src/services/schemas/CleanupPolicyV3.d.ts +19 -0
- package/dist/har-service/src/services/schemas/CleanupPolicyV3.js +4 -0
- package/dist/har-service/src/services/schemas/DebianConfigV3.d.ts +14 -0
- package/dist/har-service/src/services/schemas/DebianConfigV3.js +4 -0
- package/dist/har-service/src/services/schemas/RegistryConfigV3.d.ts +10 -0
- package/dist/har-service/src/services/schemas/RegistryConfigV3.js +1 -0
- package/dist/har-service/src/services/schemas/RegistryCreateBodyV3.d.ts +52 -0
- package/dist/har-service/src/services/schemas/RegistryCreateBodyV3.js +1 -0
- package/dist/har-service/src/services/schemas/RegistryDetailV3.d.ts +30 -0
- package/dist/har-service/src/services/schemas/RegistryDetailV3.js +1 -0
- package/dist/har-service/src/services/schemas/ScannerV3.d.ts +11 -0
- package/dist/har-service/src/services/schemas/ScannerV3.js +4 -0
- package/dist/har-service/src/services/schemas/SearchFileItemV3.d.ts +17 -0
- package/dist/har-service/src/services/schemas/SearchPackageItemV3.d.ts +26 -13
- package/dist/har-service/src/services/schemas/SearchRegistryItemV3.d.ts +24 -0
- package/dist/har-service/src/services/schemas/SearchRegistryItemV3.js +0 -3
- package/dist/har-service/src/services/schemas/SearchVersionItemV3.d.ts +32 -16
- package/dist/har-service/src/services/schemas/SigningConfigV3.d.ts +15 -0
- package/dist/har-service/src/services/schemas/SigningConfigV3.js +4 -0
- package/dist/har-service/src/services/schemas/TreeNodeItemV3.d.ts +1 -1
- package/dist/har-service/src/services/schemas/UpstreamAuthAccessKeySecretKeyV3.d.ts +27 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthAccessKeySecretKeyV3.js +4 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthBearerTokenV3.d.ts +14 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthBearerTokenV3.js +4 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthTypeV3.d.ts +6 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthTypeV3.js +4 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthUserPasswordV3.d.ts +16 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthUserPasswordV3.js +4 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthV3.d.ts +8 -0
- package/dist/har-service/src/services/schemas/UpstreamAuthV3.js +1 -0
- package/dist/har-service/src/services/schemas/UpstreamConfigV3.d.ts +36 -0
- package/dist/har-service/src/services/schemas/UpstreamConfigV3.js +1 -0
- package/dist/har-service/src/services/schemas/UpstreamSourceV3.d.ts +6 -0
- package/dist/har-service/src/services/schemas/UpstreamSourceV3.js +4 -0
- package/dist/har-service/src/services/schemas/VirtualConfigV3.d.ts +14 -0
- package/dist/har-service/src/services/schemas/VirtualConfigV3.js +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { UseMutationOptions } from '@tanstack/react-query';
|
|
2
|
+
import type { RegistryResponseV3Response } from '../responses/RegistryResponseV3Response';
|
|
3
|
+
import type { ErrorV3 } from '../schemas/ErrorV3';
|
|
4
|
+
import type { RegistryCreateRequestV3RequestBody } from '../requestBodies/RegistryCreateRequestV3RequestBody';
|
|
5
|
+
import type { ResponseWithPagination } from '../helpers';
|
|
6
|
+
import { FetcherOptions } from '../../../../fetcher/index.js';
|
|
7
|
+
export interface CreateRegistryV3MutationQueryParams {
|
|
8
|
+
account_identifier: string;
|
|
9
|
+
org_identifier?: string;
|
|
10
|
+
project_identifier?: string;
|
|
11
|
+
}
|
|
12
|
+
export type CreateRegistryV3RequestBody = RegistryCreateRequestV3RequestBody;
|
|
13
|
+
export type CreateRegistryV3OkResponse = ResponseWithPagination<RegistryResponseV3Response>;
|
|
14
|
+
export type CreateRegistryV3ErrorResponse = ErrorV3;
|
|
15
|
+
export interface CreateRegistryV3Props extends Omit<FetcherOptions<CreateRegistryV3MutationQueryParams, CreateRegistryV3RequestBody>, 'url'> {
|
|
16
|
+
queryParams: CreateRegistryV3MutationQueryParams;
|
|
17
|
+
body: CreateRegistryV3RequestBody;
|
|
18
|
+
}
|
|
19
|
+
export declare function createRegistryV3(props: CreateRegistryV3Props): Promise<CreateRegistryV3OkResponse>;
|
|
20
|
+
/**
|
|
21
|
+
* Creates a registry in the scope given by the account, org and project identifiers. The scope is taken from the query parameters, so the body carries no parent reference.
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
export declare function useCreateRegistryV3Mutation(options?: Omit<UseMutationOptions<CreateRegistryV3OkResponse, CreateRegistryV3ErrorResponse, CreateRegistryV3Props>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<CreateRegistryV3OkResponse, ErrorV3, CreateRegistryV3Props, unknown>;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
// This code is autogenerated using @harnessio/oats-cli.
|
|
3
|
+
// Please do not modify this code directly.
|
|
4
|
+
import { useMutation } from '@tanstack/react-query';
|
|
5
|
+
import { fetcher } from '../../../../fetcher/index.js';
|
|
6
|
+
export function createRegistryV3(props) {
|
|
7
|
+
return fetcher(Object.assign({ url: `/v3/registries`, method: 'POST' }, props));
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Creates a registry in the scope given by the account, org and project identifiers. The scope is taken from the query parameters, so the body carries no parent reference.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
export function useCreateRegistryV3Mutation(options) {
|
|
14
|
+
return useMutation((mutateProps) => createRegistryV3(mutateProps), options);
|
|
15
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { UseQueryOptions } from '@tanstack/react-query';
|
|
2
|
+
import type { RegistryResponseV3Response } from '../responses/RegistryResponseV3Response';
|
|
3
|
+
import type { ErrorV3 } from '../schemas/ErrorV3';
|
|
4
|
+
import type { ResponseWithPagination } from '../helpers';
|
|
5
|
+
import { FetcherOptions } from '../../../../fetcher/index.js';
|
|
6
|
+
export interface GetRegistryV3QueryPathParams {
|
|
7
|
+
id: string;
|
|
8
|
+
}
|
|
9
|
+
export interface GetRegistryV3QueryQueryParams {
|
|
10
|
+
account_identifier: string;
|
|
11
|
+
org_identifier?: string;
|
|
12
|
+
project_identifier?: string;
|
|
13
|
+
}
|
|
14
|
+
export type GetRegistryV3OkResponse = ResponseWithPagination<RegistryResponseV3Response>;
|
|
15
|
+
export type GetRegistryV3ErrorResponse = ErrorV3;
|
|
16
|
+
export interface GetRegistryV3Props extends GetRegistryV3QueryPathParams, Omit<FetcherOptions<GetRegistryV3QueryQueryParams, unknown>, 'url'> {
|
|
17
|
+
queryParams: GetRegistryV3QueryQueryParams;
|
|
18
|
+
}
|
|
19
|
+
export declare function getRegistryV3(props: GetRegistryV3Props): Promise<GetRegistryV3OkResponse>;
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves a single registry by its UUID, including its configuration and other nested settings that are omitted from list results. Soft-deleted registries are returned as well, so that a caller holding a UUID can read one in order to restore it; `deletedAt` and `deletedBy` report the deletion.
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
export declare function useGetRegistryV3Query(props: GetRegistryV3Props, options?: Omit<UseQueryOptions<GetRegistryV3OkResponse, GetRegistryV3ErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetRegistryV3OkResponse, ErrorV3>;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
// This code is autogenerated using @harnessio/oats-cli.
|
|
3
|
+
// Please do not modify this code directly.
|
|
4
|
+
import { useQuery } from '@tanstack/react-query';
|
|
5
|
+
import { fetcher } from '../../../../fetcher/index.js';
|
|
6
|
+
export function getRegistryV3(props) {
|
|
7
|
+
return fetcher(Object.assign({ url: `/v3/registries/${props.id}`, method: 'GET' }, props));
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Retrieves a single registry by its UUID, including its configuration and other nested settings that are omitted from list results. Soft-deleted registries are returned as well, so that a caller holding a UUID can read one in order to restore it; `deletedAt` and `deletedBy` report the deletion.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
export function useGetRegistryV3Query(props, options) {
|
|
14
|
+
return useQuery(['GetRegistryV3', props.id, props.queryParams], ({ signal }) => getRegistryV3(Object.assign(Object.assign({}, props), { signal })), options);
|
|
15
|
+
}
|
|
@@ -17,9 +17,8 @@ export interface ListTreeRootsV3QueryQueryParams {
|
|
|
17
17
|
* @default "exclude_deleted"
|
|
18
18
|
*/
|
|
19
19
|
deleted_filter?: 'exclude_deleted' | 'include_deleted' | 'only_deleted';
|
|
20
|
-
search?: string;
|
|
21
20
|
registry_type?: string;
|
|
22
|
-
|
|
21
|
+
package_types?: string[];
|
|
23
22
|
}
|
|
24
23
|
export type ListTreeRootsV3OkResponse = ResponseWithPagination<TreeResponseV3Response>;
|
|
25
24
|
export type ListTreeRootsV3ErrorResponse = ErrorV3;
|
|
@@ -16,6 +16,6 @@ export interface RebuildRegistryIndexV3Props extends RebuildRegistryIndexV3Mutat
|
|
|
16
16
|
}
|
|
17
17
|
export declare function rebuildRegistryIndexV3(props: RebuildRegistryIndexV3Props): Promise<RebuildRegistryIndexV3OkResponse>;
|
|
18
18
|
/**
|
|
19
|
-
* Trigger an asynchronous rebuild of the repository index for the given registry. The rebuild runs in the background; this endpoint returns immediately once the request is accepted. Index rebuild is package-type specific
|
|
19
|
+
* Trigger an asynchronous rebuild of the repository index for the given registry. The rebuild runs in the background; this endpoint returns immediately once the request is accepted. Index rebuild is package-type specific. Registries whose package type does not maintain a rebuildable index return 405.
|
|
20
20
|
*/
|
|
21
21
|
export declare function useRebuildRegistryIndexV3Mutation(options?: Omit<UseMutationOptions<RebuildRegistryIndexV3OkResponse, RebuildRegistryIndexV3ErrorResponse, RebuildRegistryIndexV3Props>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<RebuildRegistryIndexV3OkResponse, ErrorV3, RebuildRegistryIndexV3Props, unknown>;
|
|
@@ -7,7 +7,7 @@ export function rebuildRegistryIndexV3(props) {
|
|
|
7
7
|
return fetcher(Object.assign({ url: `/v3/registries/${props.id}/rebuild-index`, method: 'POST' }, props));
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* Trigger an asynchronous rebuild of the repository index for the given registry. The rebuild runs in the background; this endpoint returns immediately once the request is accepted. Index rebuild is package-type specific
|
|
10
|
+
* Trigger an asynchronous rebuild of the repository index for the given registry. The rebuild runs in the background; this endpoint returns immediately once the request is accepted. Index rebuild is package-type specific. Registries whose package type does not maintain a rebuildable index return 405.
|
|
11
11
|
*/
|
|
12
12
|
export function useRebuildRegistryIndexV3Mutation(options) {
|
|
13
13
|
return useMutation((mutateProps) => rebuildRegistryIndexV3(mutateProps), options);
|
|
@@ -14,7 +14,7 @@ export interface ResolveTreePathV3QueryQueryParams {
|
|
|
14
14
|
*/
|
|
15
15
|
deleted_filter?: 'exclude_deleted' | 'include_deleted' | 'only_deleted';
|
|
16
16
|
registry_type?: string;
|
|
17
|
-
|
|
17
|
+
package_types?: string[];
|
|
18
18
|
cursor?: string;
|
|
19
19
|
/**
|
|
20
20
|
* @default 50
|
|
@@ -39,7 +39,7 @@ export declare function resolveTreePathV3(props: ResolveTreePathV3Props): Promis
|
|
|
39
39
|
* pages from those endpoints with `children.pagination.nextCursor`. A file has no children.
|
|
40
40
|
*
|
|
41
41
|
* Every step must be a node the list endpoints would show under the same `scope`,
|
|
42
|
-
* `deleted_filter`, `registry_type` and `
|
|
42
|
+
* `deleted_filter`, `registry_type` and `package_types`; send the same values to both. A path
|
|
43
43
|
* that does not fully resolve, or whose registry is outside `scope` or excluded by a filter,
|
|
44
44
|
* returns 404. Resolving requires view permission on the registry, as for
|
|
45
45
|
* `ListRegistryNodesV3` (403 otherwise). A malformed path, `size` or `cursor` returns 400.
|
|
@@ -17,7 +17,7 @@ export function resolveTreePathV3(props) {
|
|
|
17
17
|
* pages from those endpoints with `children.pagination.nextCursor`. A file has no children.
|
|
18
18
|
*
|
|
19
19
|
* Every step must be a node the list endpoints would show under the same `scope`,
|
|
20
|
-
* `deleted_filter`, `registry_type` and `
|
|
20
|
+
* `deleted_filter`, `registry_type` and `package_types`; send the same values to both. A path
|
|
21
21
|
* that does not fully resolve, or whose registry is outside `scope` or excluded by a filter,
|
|
22
22
|
* returns 404. Resolving requires view permission on the registry, as for
|
|
23
23
|
* `ListRegistryNodesV3` (403 otherwise). A malformed path, `size` or `cursor` returns 400.
|
|
@@ -17,7 +17,7 @@ export interface SearchTreeV3QueryQueryParams {
|
|
|
17
17
|
packages_cursor?: string;
|
|
18
18
|
versions_cursor?: string;
|
|
19
19
|
files_cursor?: string;
|
|
20
|
-
|
|
20
|
+
package_types?: string[];
|
|
21
21
|
registry_type?: string;
|
|
22
22
|
/**
|
|
23
23
|
* @default "exclude_deleted"
|
|
@@ -42,8 +42,11 @@ export declare function searchTreeV3(props: SearchTreeV3Props): Promise<SearchTr
|
|
|
42
42
|
* returned empty with `timedOut: true` and the other groups are returned as normal; the
|
|
43
43
|
* request fails with 504 only when every group timed out.
|
|
44
44
|
*
|
|
45
|
+
* Hits carry the same fields as `TreeNodeItemV3` except `hasChildren`: `id` is the tree node
|
|
46
|
+
* id, `entityId` the registry/package/version UUID.
|
|
47
|
+
*
|
|
45
48
|
* Registries and Files hits are always navigable. Packages and Versions hits are navigable
|
|
46
|
-
* when they carry `
|
|
49
|
+
* when they carry `id`; render the others as non-navigable.
|
|
47
50
|
*
|
|
48
51
|
*/
|
|
49
52
|
export declare function useSearchTreeV3Query(props: SearchTreeV3Props, options?: Omit<UseQueryOptions<SearchTreeV3OkResponse, SearchTreeV3ErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<SearchTreeV3OkResponse, ErrorV3>;
|
|
@@ -18,8 +18,11 @@ export function searchTreeV3(props) {
|
|
|
18
18
|
* returned empty with `timedOut: true` and the other groups are returned as normal; the
|
|
19
19
|
* request fails with 504 only when every group timed out.
|
|
20
20
|
*
|
|
21
|
+
* Hits carry the same fields as `TreeNodeItemV3` except `hasChildren`: `id` is the tree node
|
|
22
|
+
* id, `entityId` the registry/package/version UUID.
|
|
23
|
+
*
|
|
21
24
|
* Registries and Files hits are always navigable. Packages and Versions hits are navigable
|
|
22
|
-
* when they carry `
|
|
25
|
+
* when they carry `id`; render the others as non-navigable.
|
|
23
26
|
*
|
|
24
27
|
*/
|
|
25
28
|
export function useSearchTreeV3Query(props, options) {
|
|
@@ -27,6 +27,8 @@ export type { CreateLifecycleRuleV3ErrorResponse, CreateLifecycleRuleV3MutationQ
|
|
|
27
27
|
export { createLifecycleRuleV3, useCreateLifecycleRuleV3Mutation, } from './hooks/useCreateLifecycleRuleV3Mutation';
|
|
28
28
|
export type { CreateRegistryErrorResponse, CreateRegistryMutationQueryParams, CreateRegistryOkResponse, CreateRegistryProps, CreateRegistryRequestBody, } from './hooks/useCreateRegistryMutation';
|
|
29
29
|
export { createRegistry, useCreateRegistryMutation } from './hooks/useCreateRegistryMutation';
|
|
30
|
+
export type { CreateRegistryV3ErrorResponse, CreateRegistryV3MutationQueryParams, CreateRegistryV3OkResponse, CreateRegistryV3Props, CreateRegistryV3RequestBody, } from './hooks/useCreateRegistryV3Mutation';
|
|
31
|
+
export { createRegistryV3, useCreateRegistryV3Mutation } from './hooks/useCreateRegistryV3Mutation';
|
|
30
32
|
export type { CreateReplicationRuleErrorResponse, CreateReplicationRuleMutationQueryParams, CreateReplicationRuleOkResponse, CreateReplicationRuleProps, CreateReplicationRuleRequestBody, } from './hooks/useCreateReplicationRuleMutation';
|
|
31
33
|
export { createReplicationRule, useCreateReplicationRuleMutation, } from './hooks/useCreateReplicationRuleMutation';
|
|
32
34
|
export type { CreateWebhookErrorResponse, CreateWebhookMutationPathParams, CreateWebhookOkResponse, CreateWebhookProps, CreateWebhookRequestBody, } from './hooks/useCreateWebhookMutation';
|
|
@@ -183,6 +185,8 @@ export type { GetRegistryErrorResponse, GetRegistryOkResponse, GetRegistryProps,
|
|
|
183
185
|
export { getRegistry, useGetRegistryQuery } from './hooks/useGetRegistryQuery';
|
|
184
186
|
export type { GetRegistryRootsIndexStatusV3ErrorResponse, GetRegistryRootsIndexStatusV3OkResponse, GetRegistryRootsIndexStatusV3Props, GetRegistryRootsIndexStatusV3QueryQueryParams, } from './hooks/useGetRegistryRootsIndexStatusV3Query';
|
|
185
187
|
export { getRegistryRootsIndexStatusV3, useGetRegistryRootsIndexStatusV3Query, } from './hooks/useGetRegistryRootsIndexStatusV3Query';
|
|
188
|
+
export type { GetRegistryV3ErrorResponse, GetRegistryV3OkResponse, GetRegistryV3Props, GetRegistryV3QueryPathParams, GetRegistryV3QueryQueryParams, } from './hooks/useGetRegistryV3Query';
|
|
189
|
+
export { getRegistryV3, useGetRegistryV3Query } from './hooks/useGetRegistryV3Query';
|
|
186
190
|
export type { GetReplicationRuleErrorResponse, GetReplicationRuleOkResponse, GetReplicationRuleProps, GetReplicationRuleQueryPathParams, } from './hooks/useGetReplicationRuleQuery';
|
|
187
191
|
export { getReplicationRule, useGetReplicationRuleQuery } from './hooks/useGetReplicationRuleQuery';
|
|
188
192
|
export type { GetSigningKeyByNameV3ErrorResponse, GetSigningKeyByNameV3OkResponse, GetSigningKeyByNameV3Props, GetSigningKeyByNameV3QueryPathParams, GetSigningKeyByNameV3QueryQueryParams, } from './hooks/useGetSigningKeyByNameV3Query';
|
|
@@ -390,6 +394,7 @@ export type { MetadataRequestV3RequestBody } from './requestBodies/MetadataReque
|
|
|
390
394
|
export type { PackagesStatsRequestV3RequestBody } from './requestBodies/PackagesStatsRequestV3RequestBody';
|
|
391
395
|
export type { QuarantineRequestRequestBody } from './requestBodies/QuarantineRequestRequestBody';
|
|
392
396
|
export type { RegistriesStatsRequestV3RequestBody } from './requestBodies/RegistriesStatsRequestV3RequestBody';
|
|
397
|
+
export type { RegistryCreateRequestV3RequestBody } from './requestBodies/RegistryCreateRequestV3RequestBody';
|
|
393
398
|
export type { RegistryRequestRequestBody } from './requestBodies/RegistryRequestRequestBody';
|
|
394
399
|
export type { ReplicationRuleRequestRequestBody } from './requestBodies/ReplicationRuleRequestRequestBody';
|
|
395
400
|
export type { SearchRegistryFilesRequestV3RequestBody } from './requestBodies/SearchRegistryFilesRequestV3RequestBody';
|
|
@@ -487,6 +492,7 @@ export type { RedirectResponse } from './responses/RedirectResponse';
|
|
|
487
492
|
export type { RedirectV3Response } from './responses/RedirectV3Response';
|
|
488
493
|
export type { RegistriesStatsResponseV3Response } from './responses/RegistriesStatsResponseV3Response';
|
|
489
494
|
export type { RegistryResponseResponse } from './responses/RegistryResponseResponse';
|
|
495
|
+
export type { RegistryResponseV3Response } from './responses/RegistryResponseV3Response';
|
|
490
496
|
export type { ReplicationRuleResponseResponse } from './responses/ReplicationRuleResponseResponse';
|
|
491
497
|
export type { SearchTreeResponseV3Response } from './responses/SearchTreeResponseV3Response';
|
|
492
498
|
export type { SigningKeyDetailsResponseV3Response } from './responses/SigningKeyDetailsResponseV3Response';
|
|
@@ -553,6 +559,7 @@ export type { BulkScanEvaluationStatusDataV3 } from './schemas/BulkScanEvaluatio
|
|
|
553
559
|
export type { BulkScanResultItemV3 } from './schemas/BulkScanResultItemV3';
|
|
554
560
|
export type { CargoArtifactDetailConfig } from './schemas/CargoArtifactDetailConfig';
|
|
555
561
|
export type { CleanupPolicy } from './schemas/CleanupPolicy';
|
|
562
|
+
export type { CleanupPolicyV3 } from './schemas/CleanupPolicyV3';
|
|
556
563
|
export type { ClientSetupDetails } from './schemas/ClientSetupDetails';
|
|
557
564
|
export type { ClientSetupSection } from './schemas/ClientSetupSection';
|
|
558
565
|
export type { ClientSetupStep } from './schemas/ClientSetupStep';
|
|
@@ -577,6 +584,7 @@ export type { DailyStorage } from './schemas/DailyStorage';
|
|
|
577
584
|
export type { DartArtifactDetailConfig } from './schemas/DartArtifactDetailConfig';
|
|
578
585
|
export type { DebianArtifactDetailConfig } from './schemas/DebianArtifactDetailConfig';
|
|
579
586
|
export type { DebianConfig } from './schemas/DebianConfig';
|
|
587
|
+
export type { DebianConfigV3 } from './schemas/DebianConfigV3';
|
|
580
588
|
export type { DeletedAtMsV3 } from './schemas/DeletedAtMsV3';
|
|
581
589
|
export type { DeploymentDetails } from './schemas/DeploymentDetails';
|
|
582
590
|
export type { DeploymentMetadata } from './schemas/DeploymentMetadata';
|
|
@@ -748,6 +756,9 @@ export type { RegistriesStatsResponseBodyV3 } from './schemas/RegistriesStatsRes
|
|
|
748
756
|
export type { Registry } from './schemas/Registry';
|
|
749
757
|
export type { RegistryArtifactMetadata } from './schemas/RegistryArtifactMetadata';
|
|
750
758
|
export type { RegistryConfig } from './schemas/RegistryConfig';
|
|
759
|
+
export type { RegistryConfigV3 } from './schemas/RegistryConfigV3';
|
|
760
|
+
export type { RegistryCreateBodyV3 } from './schemas/RegistryCreateBodyV3';
|
|
761
|
+
export type { RegistryDetailV3 } from './schemas/RegistryDetailV3';
|
|
751
762
|
export type { RegistryMetadata } from './schemas/RegistryMetadata';
|
|
752
763
|
export type { RegistryRequest } from './schemas/RegistryRequest';
|
|
753
764
|
export type { RegistryRootsIndexBuildDataV3 } from './schemas/RegistryRootsIndexBuildDataV3';
|
|
@@ -770,6 +781,7 @@ export type { SbomDetails } from './schemas/SbomDetails';
|
|
|
770
781
|
export type { ScanMetaV3 } from './schemas/ScanMetaV3';
|
|
771
782
|
export type { ScanStatusV3 } from './schemas/ScanStatusV3';
|
|
772
783
|
export type { Scanner } from './schemas/Scanner';
|
|
784
|
+
export type { ScannerV3 } from './schemas/ScannerV3';
|
|
773
785
|
export type { SearchAncestorV3 } from './schemas/SearchAncestorV3';
|
|
774
786
|
export type { SearchFileItemV3 } from './schemas/SearchFileItemV3';
|
|
775
787
|
export type { SearchFilesGroupV3 } from './schemas/SearchFilesGroupV3';
|
|
@@ -786,6 +798,7 @@ export type { SecurityPolicyFailureDetailConfigV3 } from './schemas/SecurityPoli
|
|
|
786
798
|
export type { SecurityPolicyFailureVulnerabilityV3 } from './schemas/SecurityPolicyFailureVulnerabilityV3';
|
|
787
799
|
export type { SemverBackfillTriggerDataV3 } from './schemas/SemverBackfillTriggerDataV3';
|
|
788
800
|
export type { SigningConfig } from './schemas/SigningConfig';
|
|
801
|
+
export type { SigningConfigV3 } from './schemas/SigningConfigV3';
|
|
789
802
|
export type { SigningKeyAlgorithmV3 } from './schemas/SigningKeyAlgorithmV3';
|
|
790
803
|
export type { SigningKeyStatusV3 } from './schemas/SigningKeyStatusV3';
|
|
791
804
|
export type { SigningKeySummaryV3 } from './schemas/SigningKeySummaryV3';
|
|
@@ -817,8 +830,15 @@ export type { TypesLabelWithValues } from './schemas/TypesLabelWithValues';
|
|
|
817
830
|
export type { TypesSaveLabelInput } from './schemas/TypesSaveLabelInput';
|
|
818
831
|
export type { TypesSaveLabelValueInput } from './schemas/TypesSaveLabelValueInput';
|
|
819
832
|
export type { UpdateKeyRequestV3 } from './schemas/UpdateKeyRequestV3';
|
|
833
|
+
export type { UpstreamAuthAccessKeySecretKeyV3 } from './schemas/UpstreamAuthAccessKeySecretKeyV3';
|
|
834
|
+
export type { UpstreamAuthBearerTokenV3 } from './schemas/UpstreamAuthBearerTokenV3';
|
|
835
|
+
export type { UpstreamAuthTypeV3 } from './schemas/UpstreamAuthTypeV3';
|
|
836
|
+
export type { UpstreamAuthUserPasswordV3 } from './schemas/UpstreamAuthUserPasswordV3';
|
|
837
|
+
export type { UpstreamAuthV3 } from './schemas/UpstreamAuthV3';
|
|
820
838
|
export type { UpstreamConfig } from './schemas/UpstreamConfig';
|
|
839
|
+
export type { UpstreamConfigV3 } from './schemas/UpstreamConfigV3';
|
|
821
840
|
export type { UpstreamProxyConfigFirewallMode } from './schemas/UpstreamProxyConfigFirewallMode';
|
|
841
|
+
export type { UpstreamSourceV3 } from './schemas/UpstreamSourceV3';
|
|
822
842
|
export type { UserInfo } from './schemas/UserInfo';
|
|
823
843
|
export type { UserInfoV3 } from './schemas/UserInfoV3';
|
|
824
844
|
export type { UserPassword } from './schemas/UserPassword';
|
|
@@ -830,6 +850,7 @@ export type { VersionV3 } from './schemas/VersionV3';
|
|
|
830
850
|
export type { VersionsStatsRequestInputV3 } from './schemas/VersionsStatsRequestInputV3';
|
|
831
851
|
export type { VersionsStatsResponseBodyV3 } from './schemas/VersionsStatsResponseBodyV3';
|
|
832
852
|
export type { VirtualConfig } from './schemas/VirtualConfig';
|
|
853
|
+
export type { VirtualConfigV3 } from './schemas/VirtualConfigV3';
|
|
833
854
|
export type { VulnerabilityMetadataV3 } from './schemas/VulnerabilityMetadataV3';
|
|
834
855
|
export type { Webhook } from './schemas/Webhook';
|
|
835
856
|
export type { WebhookExecRequest } from './schemas/WebhookExecRequest';
|
|
@@ -12,6 +12,7 @@ export { createFirewallExceptionV3, useCreateFirewallExceptionV3Mutation, } from
|
|
|
12
12
|
export { createLifecycleExecutionV3, useCreateLifecycleExecutionV3Mutation, } from './hooks/useCreateLifecycleExecutionV3Mutation';
|
|
13
13
|
export { createLifecycleRuleV3, useCreateLifecycleRuleV3Mutation, } from './hooks/useCreateLifecycleRuleV3Mutation';
|
|
14
14
|
export { createRegistry, useCreateRegistryMutation } from './hooks/useCreateRegistryMutation';
|
|
15
|
+
export { createRegistryV3, useCreateRegistryV3Mutation } from './hooks/useCreateRegistryV3Mutation';
|
|
15
16
|
export { createReplicationRule, useCreateReplicationRuleMutation, } from './hooks/useCreateReplicationRuleMutation';
|
|
16
17
|
export { createWebhook, useCreateWebhookMutation } from './hooks/useCreateWebhookMutation';
|
|
17
18
|
export { defineSpaceLabel, useDefineSpaceLabelMutation } from './hooks/useDefineSpaceLabelMutation';
|
|
@@ -90,6 +91,7 @@ export { getRegistryMetadataV3, useGetRegistryMetadataV3Query, } from './hooks/u
|
|
|
90
91
|
export { getRegistryPublicKeyV3, useGetRegistryPublicKeyV3Query, } from './hooks/useGetRegistryPublicKeyV3Query';
|
|
91
92
|
export { getRegistry, useGetRegistryQuery } from './hooks/useGetRegistryQuery';
|
|
92
93
|
export { getRegistryRootsIndexStatusV3, useGetRegistryRootsIndexStatusV3Query, } from './hooks/useGetRegistryRootsIndexStatusV3Query';
|
|
94
|
+
export { getRegistryV3, useGetRegistryV3Query } from './hooks/useGetRegistryV3Query';
|
|
93
95
|
export { getReplicationRule, useGetReplicationRuleQuery } from './hooks/useGetReplicationRuleQuery';
|
|
94
96
|
export { getSigningKeyByNameV3, useGetSigningKeyByNameV3Query, } from './hooks/useGetSigningKeyByNameV3Query';
|
|
95
97
|
export { getSigningKeyPublicKeyV3, useGetSigningKeyPublicKeyV3Query, } from './hooks/useGetSigningKeyPublicKeyV3Query';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A cleanup policy describing which versions a registry should expire.
|
|
3
|
+
*/
|
|
4
|
+
export interface CleanupPolicyV3 {
|
|
5
|
+
/**
|
|
6
|
+
* Delete matching versions older than this many days.
|
|
7
|
+
* @format int32
|
|
8
|
+
*/
|
|
9
|
+
expireDays?: number;
|
|
10
|
+
name?: string;
|
|
11
|
+
/**
|
|
12
|
+
* Only packages whose name starts with one of these prefixes are considered.
|
|
13
|
+
*/
|
|
14
|
+
packagePrefix?: string[];
|
|
15
|
+
/**
|
|
16
|
+
* Only versions whose name starts with one of these prefixes are considered.
|
|
17
|
+
*/
|
|
18
|
+
versionPrefix?: string[];
|
|
19
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Debian-specific configuration. Applies only when packageType is DEBIAN.
|
|
3
|
+
*/
|
|
4
|
+
export interface DebianConfigV3 {
|
|
5
|
+
/**
|
|
6
|
+
* Additional compression formats to generate for index and metadata files.
|
|
7
|
+
*/
|
|
8
|
+
optionalIndexCompressionFormats?: Array<'.xz'>;
|
|
9
|
+
/**
|
|
10
|
+
* Architectures to index when building metadata from linked upstream registries.
|
|
11
|
+
* @default ["amd64","i386","arm64"]
|
|
12
|
+
*/
|
|
13
|
+
remoteIndexedArchitectures?: string[];
|
|
14
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { VirtualConfigV3 } from '../schemas/VirtualConfigV3';
|
|
2
|
+
import type { UpstreamConfigV3 } from '../schemas/UpstreamConfigV3';
|
|
3
|
+
import type { RegistryTypeV3 } from '../schemas/RegistryTypeV3';
|
|
4
|
+
/**
|
|
5
|
+
* Type-specific configuration for a registry. Discriminated by type: set type to VIRTUAL for a virtual registry or UPSTREAM for an upstream proxy, and supply the matching variant.
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export type RegistryConfigV3 = (VirtualConfigV3 | UpstreamConfigV3) & {
|
|
9
|
+
type: RegistryTypeV3;
|
|
10
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import type { RegistryConfigV3 } from '../schemas/RegistryConfigV3';
|
|
2
|
+
import type { PackageTypeV3 } from '../schemas/PackageTypeV3';
|
|
3
|
+
import type { ScannerV3 } from '../schemas/ScannerV3';
|
|
4
|
+
/**
|
|
5
|
+
* Body for creating a registry. The parent scope comes from the
|
|
6
|
+
* account_identifier, org_identifier and project_identifier query
|
|
7
|
+
* parameters, so there is no parent reference here.
|
|
8
|
+
*
|
|
9
|
+
* `cleanupPolicy` is not accepted. Cleanup policies are deprecated, so a new registry is
|
|
10
|
+
* never created with one; the field is left out rather than accepted and discarded
|
|
11
|
+
* silently. Policies on registries that already have them are reported by the single
|
|
12
|
+
* registry responses and are not removed by this API.
|
|
13
|
+
*
|
|
14
|
+
*/
|
|
15
|
+
export interface RegistryCreateBodyV3<T0 extends RegistryConfigV3 = RegistryConfigV3> {
|
|
16
|
+
/**
|
|
17
|
+
* Patterns of artifacts allowed in this registry.
|
|
18
|
+
*/
|
|
19
|
+
allowedPattern?: string[];
|
|
20
|
+
/**
|
|
21
|
+
* Patterns of artifacts blocked from this registry.
|
|
22
|
+
*/
|
|
23
|
+
blockedPattern?: string[];
|
|
24
|
+
config: T0;
|
|
25
|
+
/**
|
|
26
|
+
* Human readable description of the registry.
|
|
27
|
+
*/
|
|
28
|
+
description?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Identifier of the registry, unique within the parent scope. This is the only identifier accepted on create, because no UUID exists yet.
|
|
31
|
+
*
|
|
32
|
+
*/
|
|
33
|
+
identifier: string;
|
|
34
|
+
/**
|
|
35
|
+
* Whether the registry is readable without authentication.
|
|
36
|
+
*/
|
|
37
|
+
isPublic?: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Whether OPA metadata validation is enforced on this registry.
|
|
40
|
+
*/
|
|
41
|
+
opaMetadataValidation?: boolean;
|
|
42
|
+
packageType: PackageTypeV3;
|
|
43
|
+
/**
|
|
44
|
+
* References to Harness OPA policy sets to apply to this registry. These are Harness platform entities addressed by identifier and scope across all of Harness, so they are not UUIDs.
|
|
45
|
+
*
|
|
46
|
+
*/
|
|
47
|
+
policyRefs?: string[];
|
|
48
|
+
/**
|
|
49
|
+
* Vulnerability scanners to enable on this registry.
|
|
50
|
+
*/
|
|
51
|
+
scanners?: ScannerV3[];
|
|
52
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { CleanupPolicyV3 } from '../schemas/CleanupPolicyV3';
|
|
2
|
+
import type { RegistryConfigV3 } from '../schemas/RegistryConfigV3';
|
|
3
|
+
import type { CreatedAtMsV3 } from '../schemas/CreatedAtMsV3';
|
|
4
|
+
import type { ScannerV3 } from '../schemas/ScannerV3';
|
|
5
|
+
import type { RegistryV3 } from '../schemas/RegistryV3';
|
|
6
|
+
export interface RegistryDetailV3<T0 extends RegistryConfigV3 = RegistryConfigV3> extends RegistryV3 {
|
|
7
|
+
/**
|
|
8
|
+
* Patterns of artifacts allowed in this registry.
|
|
9
|
+
*/
|
|
10
|
+
allowedPattern?: string[];
|
|
11
|
+
/**
|
|
12
|
+
* Patterns of artifacts blocked from this registry.
|
|
13
|
+
*/
|
|
14
|
+
blockedPattern?: string[];
|
|
15
|
+
/**
|
|
16
|
+
* Cleanup policies for this registry.
|
|
17
|
+
*/
|
|
18
|
+
cleanupPolicy?: CleanupPolicyV3[];
|
|
19
|
+
config?: T0;
|
|
20
|
+
createdAt?: CreatedAtMsV3;
|
|
21
|
+
/**
|
|
22
|
+
* References to Harness OPA policy sets applied to this registry. These are Harness platform entities addressed by identifier and scope across all of Harness, so they are not UUIDs.
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
policyRefs?: string[];
|
|
26
|
+
/**
|
|
27
|
+
* Vulnerability scanners enabled on this registry.
|
|
28
|
+
*/
|
|
29
|
+
scanners?: ScannerV3[];
|
|
30
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A vulnerability scanner enabled on a registry.
|
|
3
|
+
*/
|
|
4
|
+
export interface ScannerV3 {
|
|
5
|
+
/**
|
|
6
|
+
* Scanner name. Known values include: AQUA_TRIVY, GRYPE. This field is extensible; clients must handle unknown values.
|
|
7
|
+
*
|
|
8
|
+
* @example "AQUA_TRIVY"
|
|
9
|
+
*/
|
|
10
|
+
name?: string;
|
|
11
|
+
}
|
|
@@ -12,6 +12,11 @@ export interface SearchFileItemV3 {
|
|
|
12
12
|
*
|
|
13
13
|
*/
|
|
14
14
|
ancestors: SearchAncestorV3[];
|
|
15
|
+
/**
|
|
16
|
+
* Creation time in epoch millis.
|
|
17
|
+
* @format int64
|
|
18
|
+
*/
|
|
19
|
+
createdAt?: number;
|
|
15
20
|
/**
|
|
16
21
|
* Effective soft-deletion time in epoch milliseconds, as on `TreeNodeItemV3`; absent
|
|
17
22
|
* when live.
|
|
@@ -34,6 +39,10 @@ export interface SearchFileItemV3 {
|
|
|
34
39
|
id: string;
|
|
35
40
|
isFile: boolean;
|
|
36
41
|
name: string;
|
|
42
|
+
/**
|
|
43
|
+
* Package type of the registry.
|
|
44
|
+
*/
|
|
45
|
+
packageType: string;
|
|
37
46
|
/**
|
|
38
47
|
* Full path of this node within its registry.
|
|
39
48
|
*/
|
|
@@ -43,4 +52,12 @@ export interface SearchFileItemV3 {
|
|
|
43
52
|
*/
|
|
44
53
|
registryId: string;
|
|
45
54
|
registryName: string;
|
|
55
|
+
/**
|
|
56
|
+
* Canonical tree address of the node.
|
|
57
|
+
*/
|
|
58
|
+
treePath: string;
|
|
59
|
+
/**
|
|
60
|
+
* Node type, as on its tree row.
|
|
61
|
+
*/
|
|
62
|
+
type: 'file' | 'folder' | 'package' | 'version';
|
|
46
63
|
}
|
|
@@ -1,15 +1,23 @@
|
|
|
1
1
|
import type { SearchAncestorV3 } from '../schemas/SearchAncestorV3';
|
|
2
|
+
import type { TreeEntityKindV3 } from '../schemas/TreeEntityKindV3';
|
|
2
3
|
/**
|
|
3
4
|
* One row of the Packages group. Covers every package type, not only Docker/Helm.
|
|
5
|
+
* A hit without `id` is not navigable (e.g. uncached UPSTREAM packages, HELM_HTTP, CRAN);
|
|
6
|
+
* still render it and open details via `entityId`.
|
|
4
7
|
*
|
|
5
8
|
*/
|
|
6
9
|
export interface SearchPackageItemV3 {
|
|
7
10
|
/**
|
|
8
11
|
* Breadcrumb from the registry root down to this package's immediate parent, shallowest
|
|
9
|
-
* first. Present exactly when `
|
|
12
|
+
* first. Present exactly when `id` is.
|
|
10
13
|
*
|
|
11
14
|
*/
|
|
12
15
|
ancestors?: SearchAncestorV3[];
|
|
16
|
+
/**
|
|
17
|
+
* Creation time in epoch millis.
|
|
18
|
+
* @format int64
|
|
19
|
+
*/
|
|
20
|
+
createdAt?: number;
|
|
13
21
|
/**
|
|
14
22
|
* Soft-deletion time in epoch milliseconds; absent when the package is live. Only present
|
|
15
23
|
* when the request's `deleted_filter` is `include_deleted` or `only_deleted`.
|
|
@@ -21,28 +29,33 @@ export interface SearchPackageItemV3 {
|
|
|
21
29
|
* Package UUID.
|
|
22
30
|
* @format uuid
|
|
23
31
|
*/
|
|
24
|
-
|
|
25
|
-
|
|
32
|
+
entityId: string;
|
|
33
|
+
entityKind: TreeEntityKindV3;
|
|
26
34
|
/**
|
|
27
|
-
* Tree node of
|
|
28
|
-
* `ListNodeChildrenV3`. Same format as `TreeNodeItemV3.id` - for Docker/Helm the
|
|
29
|
-
* synthetic `image:<registryUUID>:<packageUUID>` - hence a plain string.
|
|
30
|
-
*
|
|
31
|
-
* **Absent means the hit is not navigable; still render it**, as a non-navigable
|
|
32
|
-
* result. This is a normal state: e.g. an UPSTREAM proxy package whose files were never
|
|
33
|
-
* cached, HELM_HTTP and CRAN (no package folder in their layout), or a best-effort
|
|
34
|
-
* location lookup that did not complete.
|
|
35
|
-
*
|
|
35
|
+
* Tree node id of the package (synthetic for Docker/Helm). Absent when not navigable.
|
|
36
36
|
*/
|
|
37
|
-
|
|
37
|
+
id?: string;
|
|
38
|
+
name: string;
|
|
38
39
|
/**
|
|
39
40
|
* Absent for package types that don't record one.
|
|
40
41
|
*/
|
|
41
42
|
packageKind?: string;
|
|
42
43
|
packageType: string;
|
|
44
|
+
/**
|
|
45
|
+
* Path of the node within its registry. Present exactly when `id` is.
|
|
46
|
+
*/
|
|
47
|
+
path?: string;
|
|
43
48
|
/**
|
|
44
49
|
* @format uuid
|
|
45
50
|
*/
|
|
46
51
|
registryId: string;
|
|
47
52
|
registryName: string;
|
|
53
|
+
/**
|
|
54
|
+
* Canonical tree address of the node. Present exactly when `id` is.
|
|
55
|
+
*/
|
|
56
|
+
treePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* Always `package`.
|
|
59
|
+
*/
|
|
60
|
+
type: 'package';
|
|
48
61
|
}
|
|
@@ -1,7 +1,13 @@
|
|
|
1
|
+
import type { TreeEntityKindV3 } from '../schemas/TreeEntityKindV3';
|
|
1
2
|
/**
|
|
2
3
|
* One row of the Registries group.
|
|
3
4
|
*/
|
|
4
5
|
export interface SearchRegistryItemV3 {
|
|
6
|
+
/**
|
|
7
|
+
* Creation time in epoch millis.
|
|
8
|
+
* @format int64
|
|
9
|
+
*/
|
|
10
|
+
createdAt?: number;
|
|
5
11
|
/**
|
|
6
12
|
* Soft-deletion time in epoch milliseconds; absent when the registry is live. Only present
|
|
7
13
|
* when the request's `deleted_filter` is `include_deleted` or `only_deleted`.
|
|
@@ -9,6 +15,12 @@ export interface SearchRegistryItemV3 {
|
|
|
9
15
|
* @format int64
|
|
10
16
|
*/
|
|
11
17
|
deletedAt?: number;
|
|
18
|
+
/**
|
|
19
|
+
* Registry UUID (same as `id`).
|
|
20
|
+
* @format uuid
|
|
21
|
+
*/
|
|
22
|
+
entityId: string;
|
|
23
|
+
entityKind: TreeEntityKindV3;
|
|
12
24
|
/**
|
|
13
25
|
* Registry UUID; expand it with `ListRegistryNodesV3`.
|
|
14
26
|
* @format uuid
|
|
@@ -16,6 +28,10 @@ export interface SearchRegistryItemV3 {
|
|
|
16
28
|
id: string;
|
|
17
29
|
name: string;
|
|
18
30
|
packageType: string;
|
|
31
|
+
/**
|
|
32
|
+
* Registry name.
|
|
33
|
+
*/
|
|
34
|
+
path: string;
|
|
19
35
|
registryType: string;
|
|
20
36
|
/**
|
|
21
37
|
* Path of the space that owns the registry (e.g. `account/org/project`), which tells
|
|
@@ -23,4 +39,12 @@ export interface SearchRegistryItemV3 {
|
|
|
23
39
|
*
|
|
24
40
|
*/
|
|
25
41
|
spacePath?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Canonical tree address; see `TreeNodeItemV3.treePath`.
|
|
44
|
+
*/
|
|
45
|
+
treePath: string;
|
|
46
|
+
/**
|
|
47
|
+
* Always `registry`.
|
|
48
|
+
*/
|
|
49
|
+
type: 'registry';
|
|
26
50
|
}
|
|
@@ -1,18 +1,27 @@
|
|
|
1
1
|
import type { SearchAncestorV3 } from '../schemas/SearchAncestorV3';
|
|
2
|
+
import type { TreeEntityKindV3 } from '../schemas/TreeEntityKindV3';
|
|
2
3
|
/**
|
|
3
4
|
* One row of the Versions group. Docker and Helm versions match on their tag names only - a
|
|
4
5
|
* digest is not searchable here - and every other package type matches on the version name.
|
|
5
6
|
* One row per version, not per tag: an OCI digest carrying several tags is a single row
|
|
6
7
|
* listing them all in `tags`.
|
|
7
8
|
*
|
|
9
|
+
* A hit without `id` is not navigable (e.g. untagged Docker/Helm digests, uncached UPSTREAM
|
|
10
|
+
* versions); still render it and open details via `entityId`.
|
|
11
|
+
*
|
|
8
12
|
*/
|
|
9
13
|
export interface SearchVersionItemV3 {
|
|
10
14
|
/**
|
|
11
15
|
* Breadcrumb from the registry root down to this version's immediate parent, shallowest
|
|
12
|
-
* first. Present exactly when `
|
|
16
|
+
* first. Present exactly when `id` is.
|
|
13
17
|
*
|
|
14
18
|
*/
|
|
15
19
|
ancestors?: SearchAncestorV3[];
|
|
20
|
+
/**
|
|
21
|
+
* Creation time in epoch millis.
|
|
22
|
+
* @format int64
|
|
23
|
+
*/
|
|
24
|
+
createdAt?: number;
|
|
16
25
|
/**
|
|
17
26
|
* Soft-deletion time in epoch milliseconds; absent when the version is live. Only present
|
|
18
27
|
* when the request's `deleted_filter` is `include_deleted` or `only_deleted`.
|
|
@@ -24,7 +33,14 @@ export interface SearchVersionItemV3 {
|
|
|
24
33
|
* Version UUID.
|
|
25
34
|
* @format uuid
|
|
26
35
|
*/
|
|
27
|
-
|
|
36
|
+
entityId: string;
|
|
37
|
+
entityKind: TreeEntityKindV3;
|
|
38
|
+
/**
|
|
39
|
+
* Tree node id of the version: the archive file for HELM_HTTP/CRAN, a matching tag (else
|
|
40
|
+
* the first tag) for Docker/Helm. Absent when not navigable.
|
|
41
|
+
*
|
|
42
|
+
*/
|
|
43
|
+
id?: string;
|
|
28
44
|
/**
|
|
29
45
|
* The stored version. For Docker and Helm this is the manifest digest in an internal
|
|
30
46
|
* `<2-digit algorithm prefix><hex>` form, not `sha256:...` - display `tags` instead
|
|
@@ -32,20 +48,6 @@ export interface SearchVersionItemV3 {
|
|
|
32
48
|
*
|
|
33
49
|
*/
|
|
34
50
|
name: string;
|
|
35
|
-
/**
|
|
36
|
-
* Tree node of this version, to reveal the hit in the tree. Same format as
|
|
37
|
-
* `TreeNodeItemV3.id`, hence a plain string. For HELM_HTTP and CRAN, which have no
|
|
38
|
-
* version folder, it is the version's archive *file* node; reveal it by expanding
|
|
39
|
-
* `ancestors`. For Docker and Helm it is the tag node (`tag:<registryId>:<tagId>`) of
|
|
40
|
-
* a tag whose name matches the term, else the first tag by name.
|
|
41
|
-
*
|
|
42
|
-
* **Absent means the hit is not navigable; still render it**, as a non-navigable
|
|
43
|
-
* result. Absent for Docker and Helm digests that carry no tag; otherwise for e.g. an
|
|
44
|
-
* UPSTREAM proxy version whose files were never cached, or a best-effort location
|
|
45
|
-
* lookup that did not complete.
|
|
46
|
-
*
|
|
47
|
-
*/
|
|
48
|
-
nodeId?: string;
|
|
49
51
|
/**
|
|
50
52
|
* @format uuid
|
|
51
53
|
*/
|
|
@@ -56,6 +58,12 @@ export interface SearchVersionItemV3 {
|
|
|
56
58
|
packageKind?: string;
|
|
57
59
|
packageName: string;
|
|
58
60
|
packageType: string;
|
|
61
|
+
/**
|
|
62
|
+
* Path of the node within its registry (`<image>/<tag>` for Docker/Helm). Present exactly
|
|
63
|
+
* when `id` is.
|
|
64
|
+
*
|
|
65
|
+
*/
|
|
66
|
+
path?: string;
|
|
59
67
|
/**
|
|
60
68
|
* @format uuid
|
|
61
69
|
*/
|
|
@@ -67,4 +75,12 @@ export interface SearchVersionItemV3 {
|
|
|
67
75
|
*
|
|
68
76
|
*/
|
|
69
77
|
tags?: string[];
|
|
78
|
+
/**
|
|
79
|
+
* Canonical tree address of the node. Present exactly when `id` is.
|
|
80
|
+
*/
|
|
81
|
+
treePath?: string;
|
|
82
|
+
/**
|
|
83
|
+
* Always `version`.
|
|
84
|
+
*/
|
|
85
|
+
type: 'version';
|
|
70
86
|
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Repository metadata signing configuration, e.g. GPG signing for Debian packages.
|
|
3
|
+
*/
|
|
4
|
+
export interface SigningConfigV3 {
|
|
5
|
+
/**
|
|
6
|
+
* UUID of the signing key to use. The key must be ACTIVE and belong to the same account, org and project as the registry.
|
|
7
|
+
*
|
|
8
|
+
* @format uuid
|
|
9
|
+
*/
|
|
10
|
+
keyId?: string | null;
|
|
11
|
+
/**
|
|
12
|
+
* Whether metadata signing is enabled for this registry.
|
|
13
|
+
*/
|
|
14
|
+
signingEnabled: boolean;
|
|
15
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Access key and secret key pair. Used when authType is ACCESS_KEY_SECRET_KEY.
|
|
3
|
+
*/
|
|
4
|
+
export interface UpstreamAuthAccessKeySecretKeyV3 {
|
|
5
|
+
/**
|
|
6
|
+
* Plaintext access key. Mutually exclusive with accessKeySecretIdentifier.
|
|
7
|
+
*/
|
|
8
|
+
accessKey?: string;
|
|
9
|
+
/**
|
|
10
|
+
* Identifier of the Harness secret holding the access key.
|
|
11
|
+
*/
|
|
12
|
+
accessKeySecretIdentifier?: string;
|
|
13
|
+
/**
|
|
14
|
+
* @format int64
|
|
15
|
+
*/
|
|
16
|
+
accessKeySecretSpaceId?: number;
|
|
17
|
+
accessKeySecretSpacePath?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Identifier of the Harness secret holding the secret key.
|
|
20
|
+
*/
|
|
21
|
+
secretKeyIdentifier: string;
|
|
22
|
+
/**
|
|
23
|
+
* @format int64
|
|
24
|
+
*/
|
|
25
|
+
secretKeySpaceId?: number;
|
|
26
|
+
secretKeySpacePath?: string;
|
|
27
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bearer token held in a Harness secret. Used when authType is BEARER_TOKEN.
|
|
3
|
+
*/
|
|
4
|
+
export interface UpstreamAuthBearerTokenV3 {
|
|
5
|
+
/**
|
|
6
|
+
* Identifier of the Harness secret holding the bearer token.
|
|
7
|
+
*/
|
|
8
|
+
secretIdentifier?: string;
|
|
9
|
+
/**
|
|
10
|
+
* @format int64
|
|
11
|
+
*/
|
|
12
|
+
secretSpaceId?: number;
|
|
13
|
+
secretSpacePath?: string;
|
|
14
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Authentication scheme used against the upstream. Known values include: USER_PASSWORD, ACCESS_KEY_SECRET_KEY, BEARER_TOKEN, ANONYMOUS. This field is extensible; clients must handle unknown values. ANONYMOUS takes no auth object.
|
|
3
|
+
*
|
|
4
|
+
* @example "USER_PASSWORD"
|
|
5
|
+
*/
|
|
6
|
+
export type UpstreamAuthTypeV3 = string;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Username plus a password held in a Harness secret. Used when authType is USER_PASSWORD.
|
|
3
|
+
*/
|
|
4
|
+
export interface UpstreamAuthUserPasswordV3 {
|
|
5
|
+
/**
|
|
6
|
+
* Identifier of the Harness secret holding the password. This is a Harness platform secret, addressed by identifier and scope across all of Harness, so it is not a UUID.
|
|
7
|
+
*
|
|
8
|
+
*/
|
|
9
|
+
secretIdentifier?: string;
|
|
10
|
+
/**
|
|
11
|
+
* @format int64
|
|
12
|
+
*/
|
|
13
|
+
secretSpaceId?: number;
|
|
14
|
+
secretSpacePath?: string;
|
|
15
|
+
userName: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { UpstreamAuthUserPasswordV3 } from '../schemas/UpstreamAuthUserPasswordV3';
|
|
2
|
+
import type { UpstreamAuthAccessKeySecretKeyV3 } from '../schemas/UpstreamAuthAccessKeySecretKeyV3';
|
|
3
|
+
import type { UpstreamAuthBearerTokenV3 } from '../schemas/UpstreamAuthBearerTokenV3';
|
|
4
|
+
/**
|
|
5
|
+
* Upstream credentials. The variant is selected by the sibling authType field rather than by a property on this object, so there is no discriminator here. Omit this object entirely when authType is ANONYMOUS.
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
export type UpstreamAuthV3 = UpstreamAuthUserPasswordV3 | UpstreamAuthAccessKeySecretKeyV3 | UpstreamAuthBearerTokenV3;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { UpstreamAuthV3 } from '../schemas/UpstreamAuthV3';
|
|
2
|
+
import type { UpstreamAuthTypeV3 } from '../schemas/UpstreamAuthTypeV3';
|
|
3
|
+
import type { FirewallModeV3 } from '../schemas/FirewallModeV3';
|
|
4
|
+
import type { SigningConfigV3 } from '../schemas/SigningConfigV3';
|
|
5
|
+
import type { UpstreamSourceV3 } from '../schemas/UpstreamSourceV3';
|
|
6
|
+
/**
|
|
7
|
+
* Configuration for an upstream proxy registry.
|
|
8
|
+
*/
|
|
9
|
+
export interface UpstreamConfigV3 {
|
|
10
|
+
auth?: UpstreamAuthV3;
|
|
11
|
+
authType: UpstreamAuthTypeV3;
|
|
12
|
+
firewallMode?: FirewallModeV3;
|
|
13
|
+
/**
|
|
14
|
+
* Time-to-live in seconds for cached upstream metadata. A duration, not a timestamp, so it is expressed in seconds rather than milliseconds.
|
|
15
|
+
*
|
|
16
|
+
* @format int64
|
|
17
|
+
*/
|
|
18
|
+
metadataCacheTTL?: number;
|
|
19
|
+
/**
|
|
20
|
+
* Time-to-live in seconds for cached NOT_FOUND responses from the upstream. A duration, not a timestamp, so it is expressed in seconds rather than milliseconds.
|
|
21
|
+
*
|
|
22
|
+
* @format int64
|
|
23
|
+
*/
|
|
24
|
+
negativeCacheTTL?: number;
|
|
25
|
+
/**
|
|
26
|
+
* Optional path suffix appended to the remote URL for this registry. For Python upstreams this overrides the default `/simple` path used for PyPI-compatible indexes. Leading and trailing slashes are normalized away.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
remoteUrlSuffix?: string;
|
|
30
|
+
signingConfig?: SigningConfigV3;
|
|
31
|
+
source?: UpstreamSourceV3;
|
|
32
|
+
/**
|
|
33
|
+
* Remote URL of the upstream. Required when source is CUSTOM.
|
|
34
|
+
*/
|
|
35
|
+
url?: string;
|
|
36
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Well-known upstream this proxy points at. Known values include: DOCKERHUB, CUSTOM, AWS_ECR, MAVEN_CENTRAL, PYPI, NPMJS, NUGET_ORG, CRATES, RUBYGEMS, GO_PROXY, HUGGING_FACE, ANACONDA, PUBDEV, PACKAGIST, PUPPET_FORGE, HELM_CHART_REPO, CONAN_CENTER, TERRAFORM_REGISTRY, CRAN, WOLFI, ALPINE. This field is extensible; clients must handle unknown values. Use CUSTOM together with url for anything else.
|
|
3
|
+
*
|
|
4
|
+
* @example "DOCKERHUB"
|
|
5
|
+
*/
|
|
6
|
+
export type UpstreamSourceV3 = string;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { DebianConfigV3 } from '../schemas/DebianConfigV3';
|
|
2
|
+
import type { SigningConfigV3 } from '../schemas/SigningConfigV3';
|
|
3
|
+
/**
|
|
4
|
+
* Configuration for a virtual registry.
|
|
5
|
+
*/
|
|
6
|
+
export interface VirtualConfigV3 {
|
|
7
|
+
debianConfig?: DebianConfigV3;
|
|
8
|
+
signingConfig?: SigningConfigV3;
|
|
9
|
+
/**
|
|
10
|
+
* UUIDs of the upstream proxy registries this virtual registry resolves through, in resolution order. Note that v1 accepts upstream proxy *names* here; v3 uses UUIDs per the id-over-identifier rule.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
upstreamProxies?: string[];
|
|
14
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|