> ## 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.
# Update Repository
> Update an existing OCIRepository
An OCIRepository represents a single namespace within an OCI Registry.
OCIRepositories are uniquely identified by a URI-like string where the final
path of the URI represents the OCIRepository Namespace and the part of the URI
before the Namespace is the Registry identifier.
Examples of OCIRepository identifiers:
* docker.io/istio/pilot: The pilot namespace in the docker.io/istio
registry.
* public.ecr.aws/bottlerocket/bottlerocket-operator: The
bottlerocket-operator namespace in the public.ecr.aws/bottlerocket
registry.
## OpenAPI
````yaml put /ocirepositories/{repository}/
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:
/ocirepositories/{repository}/:
put:
tags:
- OCI
summary: Update Repository
description: >
Update an existing OCIRepository
An OCIRepository represents a single namespace within an OCI
Registry.
OCIRepositories are uniquely identified by a URI-like string where the
final
path of the URI represents the OCIRepository Namespace and the part of
the URI
before the Namespace is the Registry identifier.
Examples of OCIRepository identifiers:
* docker.io/istio/pilot: The pilot namespace in the
docker.io/istio
registry.
* public.ecr.aws/bottlerocket/bottlerocket-operator: The
bottlerocket-operator namespace in the public.ecr.aws/bottlerocket
registry.
operationId: oci-repository-update
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OCIRepository'
description: OK
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
components:
schemas:
OCIRepository:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/schemas/OCIRepository.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
last_scanned_on:
description: Time when OCI Repository was last scanned.
format: date-time
type: string
namespace:
description: >-
Namespace is the namespace of the OCIRepository within the OCI
Registry.
examples:
- s3-controller
type: string
packages:
description: >-
Packages is the list of Package IDs that this OCI Repository is
associated with.
items:
type: string
type:
- array
- 'null'
project_components:
description: >-
ProjectComponents is the list of ProjectComponent IDs that this OCI
Repository is associated with.
items:
type: string
type:
- array
- 'null'
projects:
description: >-
Projects is the list of Project IDs that this OCI Repository is
associated with.
items:
type: string
type:
- array
- 'null'
registry:
description: >-
Registry is the URL-like identifier for the OCI Registry to which
this OCI Repository belongs.
examples:
- public.ecr.aws/aws-controllers-k8s
type: string
required:
- namespace
- registry
- last_scanned_on
- projects
- project_components
- packages
- 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
````