@harnessio/react-har-service-client 0.99.0 → 0.101.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/useGetRebuildRegistryIndexStatusV3Query.d.ts +22 -0
- package/dist/har-service/src/services/hooks/useGetRebuildRegistryIndexStatusV3Query.js +14 -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/useListPackagesV3Query.d.ts +1 -0
- package/dist/har-service/src/services/hooks/useListRegistriesV3Query.d.ts +1 -0
- package/dist/har-service/src/services/hooks/useListTreeRootsV3Query.d.ts +1 -2
- package/dist/har-service/src/services/hooks/useListVersionsV3Query.d.ts +1 -0
- package/dist/har-service/src/services/hooks/usePatchRegistryV3Mutation.d.ts +30 -0
- package/dist/har-service/src/services/hooks/usePatchRegistryV3Mutation.js +18 -0
- 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/hooks/useUpdateRegistryV3Mutation.d.ts +30 -0
- package/dist/har-service/src/services/hooks/useUpdateRegistryV3Mutation.js +18 -0
- package/dist/har-service/src/services/index.d.ts +33 -0
- package/dist/har-service/src/services/index.js +5 -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/requestBodies/RegistryPatchRequestV3RequestBody.d.ts +2 -0
- package/dist/har-service/src/services/requestBodies/RegistryPatchRequestV3RequestBody.js +1 -0
- package/dist/har-service/src/services/requestBodies/RegistryUpdateRequestV3RequestBody.d.ts +2 -0
- package/dist/har-service/src/services/requestBodies/RegistryUpdateRequestV3RequestBody.js +1 -0
- package/dist/har-service/src/services/responses/GetRebuildRegistryIndexStatusResponseV3Response.d.ts +20 -0
- package/dist/har-service/src/services/responses/GetRebuildRegistryIndexStatusResponseV3Response.js +1 -0
- package/dist/har-service/src/services/responses/RebuildRegistryIndexAcceptedV3Response.d.ts +15 -1
- 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/ApmArtifactDetailConfig.d.ts +8 -0
- package/dist/har-service/src/services/schemas/ApmArtifactDetailConfig.js +4 -0
- package/dist/har-service/src/services/schemas/ArtifactDetail.d.ts +2 -1
- 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/FilterConditionV3.d.ts +1 -1
- package/dist/har-service/src/services/schemas/FilterDataTypeV3.d.ts +1 -1
- package/dist/har-service/src/services/schemas/FilterInputTypeV3.d.ts +1 -1
- package/dist/har-service/src/services/schemas/PackageType.d.ts +1 -1
- package/dist/har-service/src/services/schemas/PackageTypeV3.d.ts +1 -1
- package/dist/har-service/src/services/schemas/RebuildRegistryIndexStatusV3.d.ts +4 -0
- package/dist/har-service/src/services/schemas/RebuildRegistryIndexStatusV3.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/RegistryMutateBodyV3.d.ts +68 -0
- package/dist/har-service/src/services/schemas/RegistryMutateBodyV3.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
|
@@ -1 +1,15 @@
|
|
|
1
|
-
|
|
1
|
+
import type { RebuildRegistryIndexStatusV3 } from '../schemas/RebuildRegistryIndexStatusV3';
|
|
2
|
+
export interface RebuildRegistryIndexAcceptedV3Response {
|
|
3
|
+
data: {
|
|
4
|
+
/**
|
|
5
|
+
* Request id to poll the rebuild status with.
|
|
6
|
+
* @format uuid
|
|
7
|
+
*/
|
|
8
|
+
id: string;
|
|
9
|
+
status: RebuildRegistryIndexStatusV3;
|
|
10
|
+
/**
|
|
11
|
+
* Relative URL to poll for status (optional convenience)
|
|
12
|
+
*/
|
|
13
|
+
statusUrl?: string;
|
|
14
|
+
};
|
|
15
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -22,13 +22,14 @@ import type { CranArtifactDetailConfig } from '../schemas/CranArtifactDetailConf
|
|
|
22
22
|
import type { TerraformArtifactDetailConfig } from '../schemas/TerraformArtifactDetailConfig';
|
|
23
23
|
import type { WolfiArtifactDetailConfig } from '../schemas/WolfiArtifactDetailConfig';
|
|
24
24
|
import type { AlpineArtifactDetailConfig } from '../schemas/AlpineArtifactDetailConfig';
|
|
25
|
+
import type { ApmArtifactDetailConfig } from '../schemas/ApmArtifactDetailConfig';
|
|
25
26
|
import type { ArtifactType } from '../schemas/ArtifactType';
|
|
26
27
|
import type { UserInfo } from '../schemas/UserInfo';
|
|
27
28
|
import type { PackageType } from '../schemas/PackageType';
|
|
28
29
|
/**
|
|
29
30
|
* Artifact Detail
|
|
30
31
|
*/
|
|
31
|
-
export type ArtifactDetail = (DockerArtifactDetailConfig | HelmArtifactDetailConfig | GenericArtifactDetailConfig | MavenArtifactDetailConfig | PythonArtifactDetailConfig | NpmArtifactDetailConfig | RpmArtifactDetailConfig | NugetArtifactDetailConfig | CargoArtifactDetailConfig | GoArtifactDetailConfig | HuggingFaceArtifactDetailConfig | CondaArtifactDetailConfig | DartArtifactDetailConfig | ComposerArtifactDetailConfig | SwiftArtifactDetailConfig | PuppetArtifactDetailConfig | HelmHttpArtifactDetailConfig | DebianArtifactDetailConfig | ConanArtifactDetailConfig | RubyArtifactDetailConfig | CranArtifactDetailConfig | TerraformArtifactDetailConfig | WolfiArtifactDetailConfig | AlpineArtifactDetailConfig) & {
|
|
32
|
+
export type ArtifactDetail = (DockerArtifactDetailConfig | HelmArtifactDetailConfig | GenericArtifactDetailConfig | MavenArtifactDetailConfig | PythonArtifactDetailConfig | NpmArtifactDetailConfig | RpmArtifactDetailConfig | NugetArtifactDetailConfig | CargoArtifactDetailConfig | GoArtifactDetailConfig | HuggingFaceArtifactDetailConfig | CondaArtifactDetailConfig | DartArtifactDetailConfig | ComposerArtifactDetailConfig | SwiftArtifactDetailConfig | PuppetArtifactDetailConfig | HelmHttpArtifactDetailConfig | DebianArtifactDetailConfig | ConanArtifactDetailConfig | RubyArtifactDetailConfig | CranArtifactDetailConfig | TerraformArtifactDetailConfig | WolfiArtifactDetailConfig | AlpineArtifactDetailConfig | ApmArtifactDetailConfig) & {
|
|
32
33
|
artifactKey?: {
|
|
33
34
|
[key: string]: string;
|
|
34
35
|
};
|
|
@@ -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
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* refers to package
|
|
3
3
|
*/
|
|
4
|
-
export type PackageType = 'ALPINE' | 'CARGO' | 'COMPOSER' | 'CONAN' | 'CONDA' | 'CRAN' | 'DART' | 'DEBIAN' | 'DOCKER' | 'GENERIC' | 'GO' | 'HELM' | 'HELM_HTTP' | 'HUGGINGFACE' | 'MAVEN' | 'NPM' | 'NUGET' | 'PUPPET' | 'PYTHON' | 'RAW' | 'RPM' | 'RUBY' | 'SWIFT' | 'TERRAFORM' | 'TERRAFORM_BACKEND' | 'WOLFI';
|
|
4
|
+
export type PackageType = 'ALPINE' | 'APM' | 'CARGO' | 'COMPOSER' | 'CONAN' | 'CONDA' | 'CRAN' | 'DART' | 'DEBIAN' | 'DOCKER' | 'GENERIC' | 'GO' | 'HELM' | 'HELM_HTTP' | 'HUGGINGFACE' | 'MAVEN' | 'NPM' | 'NUGET' | 'PUPPET' | 'PYTHON' | 'RAW' | 'RPM' | 'RUBY' | 'SWIFT' | 'TERRAFORM' | 'TERRAFORM_BACKEND' | 'WOLFI';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, HELM_HTTP, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT, PUPPET, RUBY, RAW, DEBIAN, CONAN, TERRAFORM, TERRAFORM_BACKEND, CRAN, WOLFI, ALPINE. This field is extensible; clients must handle unknown values.
|
|
2
|
+
* Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, HELM_HTTP, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT, PUPPET, RUBY, RAW, DEBIAN, CONAN, TERRAFORM, TERRAFORM_BACKEND, CRAN, WOLFI, ALPINE, APM. This field is extensible; clients must handle unknown values.
|
|
3
3
|
*
|
|
4
4
|
* @example "DOCKER"
|
|
5
5
|
*/
|
|
@@ -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,68 @@
|
|
|
1
|
+
import type { RegistryConfigV3 } from '../schemas/RegistryConfigV3';
|
|
2
|
+
/**
|
|
3
|
+
* The mutable fields of a registry. `PATCH` and `PUT` share this body and differ only in how
|
|
4
|
+
* they read an absent field: `PATCH` leaves it exactly as it is, `PUT` clears it. So the same
|
|
5
|
+
* object means "change only these keys" to one verb and "this is the registry's complete
|
|
6
|
+
* desired state" to the other.
|
|
7
|
+
*
|
|
8
|
+
* Per-field notes below are written for both verbs: "clears it" is what `PUT` does with an
|
|
9
|
+
* omitted field and what either verb does with an explicitly empty one (`""` for description,
|
|
10
|
+
* `[]` for the list fields).
|
|
11
|
+
*
|
|
12
|
+
* The registry's identifier, package type and scope are not here. The path id already
|
|
13
|
+
* resolves all three, and changing any of them is rejected by the registry model rather than
|
|
14
|
+
* being an update of this registry.
|
|
15
|
+
*
|
|
16
|
+
* `config` is never merged key by key. Supplying it replaces the whole type-specific
|
|
17
|
+
* configuration, so it has to be sent complete — including `type`, which must match the
|
|
18
|
+
* registry's existing type, because VIRTUAL and UPSTREAM keep their settings in different
|
|
19
|
+
* tables and switching is a different registry rather than an edit of this one. When an
|
|
20
|
+
* upstream registry's credentials or URL change, the referenced secret is re-authorized
|
|
21
|
+
* against the caller. `PUT` requires it: replacing a registry without its configuration is
|
|
22
|
+
* not a meaningful state. `PATCH` does not, and omitting it keeps the current one verbatim.
|
|
23
|
+
*
|
|
24
|
+
* `cleanupPolicy`, `scanners`, `policyRefs` and `isInternal` are not accepted by either verb.
|
|
25
|
+
* Cleanup policies are deprecated; scanners and policy references are written by a v1-only
|
|
26
|
+
* code path that neither endpoint reaches; and `isInternal` is not settable on any API
|
|
27
|
+
* version — v1 accepts the key and ignores it, deriving the flag from the registry it already
|
|
28
|
+
* has. Accepting any of them here would take the value and discard it silently, so they are
|
|
29
|
+
* rejected instead. Use the v1 registry update if you need to change scanners or policy
|
|
30
|
+
* references.
|
|
31
|
+
*
|
|
32
|
+
* Scanner and policy rows are left untouched by either verb. Cleanup policy rows are the one
|
|
33
|
+
* exception to "omitted fields are unchanged", and for `PATCH` which body you send decides it:
|
|
34
|
+
* a patch of `description`, `allowedPattern` or `blockedPattern` alone updates those columns in
|
|
35
|
+
* place and leaves the policy rows alone, while a patch touching `config`, `isPublic` or
|
|
36
|
+
* `opaMetadataValidation` is applied by the v1 full-replacement update, which reconciles the
|
|
37
|
+
* policy table from a body that carries no policies and so deletes every row. `PUT` always
|
|
38
|
+
* takes that path, so it always clears them. A registry that still has cleanup policies
|
|
39
|
+
* therefore loses them on its next `PUT` or settings patch. This is what the v1 update already
|
|
40
|
+
* does with a body that omits the key, so it is not new behaviour, but within `PATCH` it is
|
|
41
|
+
* asymmetric — read `cleanupPolicy` back from the single-registry response if you need to know
|
|
42
|
+
* whether a registry has rows to lose.
|
|
43
|
+
*
|
|
44
|
+
*/
|
|
45
|
+
export interface RegistryMutateBodyV3<T0 extends RegistryConfigV3 = RegistryConfigV3> {
|
|
46
|
+
/**
|
|
47
|
+
* Replaces the allowed-pattern list. Send `[]` to clear it.
|
|
48
|
+
*/
|
|
49
|
+
allowedPattern?: string[];
|
|
50
|
+
/**
|
|
51
|
+
* Replaces the blocked-pattern list. Send `[]` to clear it.
|
|
52
|
+
*/
|
|
53
|
+
blockedPattern?: string[];
|
|
54
|
+
config?: T0;
|
|
55
|
+
/**
|
|
56
|
+
* Replaces the description. Send `""` to clear it.
|
|
57
|
+
*/
|
|
58
|
+
description?: string;
|
|
59
|
+
/**
|
|
60
|
+
* Sets anonymous read access. Rejected when public access is disabled for the account, or when the registry proxies a private upstream.
|
|
61
|
+
*
|
|
62
|
+
*/
|
|
63
|
+
isPublic?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Sets whether OPA metadata validation is enforced on this registry.
|
|
66
|
+
*/
|
|
67
|
+
opaMetadataValidation?: boolean;
|
|
68
|
+
}
|
|
@@ -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
|
+
}
|