> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chkk.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Create VersionSet
> Create a new PackageVersionSet
A PackageVersionSet represents a configuration, layout or structure of
a Package that is consistent for a range of PackageReleases.
A PackageComponent is associated with a single PackageVersionSet. We track
changes to the componentry and structure of a Package over time using
PackageVersionSets.
PackageVersionSets are uniquely identified by the Package ID or Alias and
a simple integer, separated by a ':' character.
Examples of PackageVersionSet identifiers:
* argo-workflows:1: the first PackageVersionSet of the Argo Workflows
Package, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third PackageVersionSet of
the Argo Workflows Package, using the Argo Workflow Package's UUID as the
identifier.
Each PackageVersionSet has a Constraint field that is a Semantic Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version Constraint
indicates which PackageReleases the PackageVersionSet describes.
## OpenAPI
````yaml post /packages/{package}/versionsets
openapi: 3.1.0
info:
description: >
The Chkk Artifact Register API exposes information about the artifacts in a
customer's clusters.
Data models exposed in the Chkk Artifact Register API include:
* Organization: the top-level object that models a Chkk customer.
* Account: a container for resource ownership within an Organization.
* KubePlatform: describes things like the cloud infrastructure
provider
and the control plane provider.
* KubeCluster: a single cluster provisioned by a
KubePlatform.
* KubeClusterScan: a single Chkk scan of a cluster.
* KubeClusterResource: a single Resource
(Deployment, DaemonSet or StatefulSet) from a KubeClusterScan.
* KubeClusterResourceContainer: a single container record in a
KubeClusterResource.
* Project: software that provides some functionality.
* ProjectReleaseSeries: a single release series for a Project.
* ProjectRelease: a single release for a Project.
* ProjectVersionSet: a configuration, layout or structure of a
Project
that is consistent for a range of ProjectReleases.
* ProjectComponent: a separate binary, daemon, or subsystem of a
Project.
* Package: a named bundle of software that is bundled (and
identified) in the format of a specific PackageSystem.
* PackageRelease: a single release for a Package.
* PackageVersionSet: a configuration, layout or structure of a
Package
that is consistent for a range of PackageReleases.
* OCIRepository: a single namespace within an OCI Registry.
* OCIArtifact: a single OCI Artifact (manifest) that describes an OCI
Image or other OCI Artifact.
* OCITag: a name that points to a unique OCIArtifact within an
OCIRepository.
* OCIReference: a relationship between an OCITag and an OCIArtifact.
* RiskSignature: the source of a potential
availability or operational risk for a customer.
* Risk: a detected RiskSignature for an Account.
* UpgradeTemplate: detailed instructions for upgrading or migrating a
KubeCluster or an installed part of a KubeCluster.
title: Chkk API
version: '1.0'
servers: []
security: []
paths:
/packages/{package}/versionsets:
post:
tags:
- Package
summary: Create VersionSet
description: >
Create a new PackageVersionSet
A PackageVersionSet represents a configuration, layout or
structure of
a Package that is consistent for a range of PackageReleases.
A PackageComponent is associated with a single PackageVersionSet. We
track
changes to the componentry and structure of a Package over time using
PackageVersionSets.
PackageVersionSets are uniquely identified by the Package ID or Alias
and
a simple integer, separated by a ':' character.
Examples of PackageVersionSet identifiers:
* argo-workflows:1: the first PackageVersionSet of the Argo
Workflows
Package, using the "argo-workflows" Alias as the identifier.
* proj_dda0b12f-9a76-43ff-a024-9839ed3ee57b:3 the third
PackageVersionSet of
the Argo Workflows Package, using the Argo Workflow Package's UUID as the
identifier.
Each PackageVersionSet has a Constraint field that is a Semantic
Versioning 2
Version Constraint, e.g. >=1.2.1 or <2.34.50. This Version
Constraint
indicates which PackageReleases the PackageVersionSet describes.
operationId: package-versionset-create
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackageVersionSet'
description: Created
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
components:
schemas:
PackageVersionSet:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/PackageVersionSet.json
format: uri
readOnly: true
type: string
created_by:
description: user who created the record.
type: string
created_on:
description: timestamp of when the record was created.
format: date-time
type: string
last_modified_by:
description: user who last modified the record.
type: string
last_modified_on:
description: timestamp of when the record was last modified.
format: date-time
type: string
number:
description: >-
The sequence number of this PackageVersionSet. Represents the number
of times a change to the Package's configuration, component
breakdown or architecture has been tracked.
examples:
- 1
format: int64
minimum: 0
type: integer
package:
description: ID of the Package for this PackageVersionSet.
examples:
- pkg_fc8c119c-0741-4062-8959-fe1a04b3842f
type: string
version_constraint:
description: >-
Version constraint that describes which range of Package Release
versions this PackageVersionSet applies to.
examples:
- '>=1.0 <2'
type: string
required:
- version_constraint
- package
- number
- created_by
- created_on
- last_modified_by
- last_modified_on
type: object
ErrorModel:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/ErrorModel.json
format: uri
readOnly: true
type: string
detail:
description: >-
A human-readable explanation specific to this occurrence of the
problem.
examples:
- Property foo is required but is missing.
type: string
errors:
description: Optional list of individual error details
items:
$ref: '#/components/schemas/ErrorDetail'
type:
- array
- 'null'
instance:
description: >-
A URI reference that identifies the specific occurrence of the
problem.
examples:
- https://example.com/error-log/abc123
format: uri
type: string
status:
description: HTTP status code
examples:
- 400
format: int64
type: integer
title:
description: >-
A short, human-readable summary of the problem type. This value
should not change between occurrences of the error.
examples:
- Bad Request
type: string
type:
default: about:blank
description: A URI reference to human-readable documentation for the error.
examples:
- https://example.com/errors/example
format: uri
type: string
type: object
ErrorDetail:
additionalProperties: false
properties:
location:
description: >-
Where the error occurred, e.g. 'body.items[3].tags' or
'path.thing-id'
type: string
message:
description: Error message text
type: string
value:
description: The value at the given location
type: object
````