Skip to content

Latest commit

 

History

History
171 lines (140 loc) · 14.4 KB

File metadata and controls

171 lines (140 loc) · 14.4 KB

RepositoryRequestPatch

Properties

Name Type Description Notes
broadcastState BroadcastStateEnum Broadcasting status of a repository. [optional]
contentKind ContentKindEnum The repository content kind determines whether this repository contains packages, or provides a distribution of packages from other repositories. You can only select the content kind at repository creation time. [optional]
contextualAuthRealm Boolean If checked, missing credentials for this repository where basic authentication is required shall present an enriched value in the 'WWW-Authenticate' header containing the namespace and repository. This can be useful for tooling such as SBT where the authentication realm is used to distinguish and disambiguate credentials. [optional]
copyOwn Boolean If checked, users can copy any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org. [optional]
copyPackages CopyPackagesEnum This defines the minimum level of privilege required for a user to copy packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific copy setting. [optional]
cosignSigningEnabled Boolean When enabled, all pushed (or pulled from upstream) OCI packages and artifacts will be signed using cosign with the repository's ECDSA key. This generates a distinct cosign signature artifact per artifact. [optional]
defaultPrivilege DefaultPrivilegeEnum This defines the default level of privilege that all of your organization members have for this repository. This does not include collaborators, but applies to any member of the org regardless of their own membership role (i.e. it applies to owners, managers and members). Be careful if setting this to admin, because any member will be able to change settings. [optional]
deleteOwn Boolean If checked, users can delete any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org. [optional]
deletePackages DeletePackagesEnum This defines the minimum level of privilege required for a user to delete packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific delete setting. [optional]
description String A description of the repository's purpose/contents. [optional]
distributes List<String> The repositories distributed through this repo. Adding repos here is only valid if the content_kind is DISTRIBUTION. [optional]
dockerRefreshTokensEnabled Boolean If checked, refresh tokens will be issued in addition to access tokens for Docker authentication. This allows unlimited extension of the lifetime of access tokens. [optional]
enforceEula Boolean If checked, downloads will explicitly require acceptance of an EULA. [optional]
genericPackageIndexEnabled Boolean If checked, HTML indexes will be generated that list all available generic packages in the repository. [optional]
indexFiles Boolean If checked, files contained in packages will be indexed, which increase the synchronisation time required for packages. Note that it is recommended you keep this enabled unless the synchronisation time is significantly impacted. [optional]
manageEntitlementsPrivilege ManageEntitlementsPrivilegeEnum This defines the minimum level of privilege required for a user to manage entitlement tokens with private repositories. Management is the ability to create, alter, enable, disable or delete all tokens without a repository. [optional]
moveOwn Boolean If checked, users can move any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org. [optional]
movePackages MovePackagesEnum This defines the minimum level of privilege required for a user to move packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific move setting. [optional]
name String A descriptive name for the repository. [optional]
nugetNativeSigningEnabled Boolean When enabled, all pushed (or pulled from upstream) nuget packages and artifacts will be signed using the repository's X.509 RSA certificate. Additionally, the nuget RepositorySignature index will list all of the repository's signing certificates including the ones from configured upstreams. [optional]
openSourceLicense String The SPDX identifier of the open source license. [optional]
openSourceProjectUrl String The URL to the Open-Source project, used for validating that the project meets the requirements for Open-Source. [optional]
proxyNpmjs Boolean If checked, Npm packages that are not in the repository when requested by clients will automatically be proxied from the public npmjs.org registry. If there is at least one version for a package, others will not be proxied. [optional]
proxyPypi Boolean If checked, Python packages that are not in the repository when requested by clients will automatically be proxied from the public pypi.python.org registry. If there is at least one version for a package, others will not be proxied. [optional]
rawPackageIndexEnabled Boolean If checked, HTML and JSON indexes will be generated that list all available raw packages in the repository. [optional]
rawPackageIndexSignaturesEnabled Boolean If checked, the HTML and JSON indexes will display raw package GPG signatures alongside the index packages. [optional]
replacePackages ReplacePackagesEnum This defines the minimum level of privilege required for a user to republish packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific republish setting. Please note that the user still requires the privilege to delete packages that will be replaced by the new package; otherwise the republish will fail. [optional]
replacePackagesByDefault Boolean If checked, uploaded packages will overwrite/replace any others with the same attributes (e.g. same version) by default. This only applies if the user has the required privilege for the republishing AND has the required privilege to delete existing packages that they don't own. [optional]
repositoryTypeStr RepositoryTypeStrEnum The repository type changes how it is accessed and billed. Private repositories are visible only to you or authorized delegates. Public repositories are visible to all Cloudsmith users. [optional]
resyncOwn Boolean If checked, users can resync any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org. [optional]
resyncPackages ResyncPackagesEnum This defines the minimum level of privilege required for a user to resync packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific resync setting. [optional]
scanOwn Boolean If checked, users can scan any of their own packages that they have uploaded, assuming that they still have write privilege for the repository. This takes precedence over privileges configured in the 'Access Controls' section of the repository, and any inherited from the org. [optional]
scanPackages ScanPackagesEnum This defines the minimum level of privilege required for a user to scan packages. Unless the package was uploaded by that user, in which the permission may be overridden by the user-specific scan setting. [optional]
showSetupAll Boolean If checked, the Set Me Up help for all formats will always be shown, even if you don't have packages of that type uploaded. Otherwise, help will only be shown for packages that are in the repository. For example, if you have uploaded only NuGet packages, then the Set Me Up help for NuGet packages will be shown only. [optional]
slug String The slug identifies the repository in URIs. [optional]
strictNpmValidation Boolean If checked, npm packages will be validated strictly to ensure the package matches specifcation. You can turn this on if you want to guarantee that the packages will work with npm-cli and other tools correctly. [optional]
tagPreReleasesAsLatest Boolean If checked, packages pushed with a pre-release component on that version will be marked with the 'latest' tag. Note that if unchecked, a repository containing ONLY pre-release versions, will have no version marked latest which may cause incompatibility with native tools [optional]
useDebianLabels Boolean If checked, a 'Label' field will be present in Debian-based repositories. It will contain a string that identifies the entitlement token used to authenticate the repository, in the form of 'source=t-<identifier>'; or 'source=none' if no token was used. You can use this to help with pinning. [optional]
useDefaultCargoUpstream Boolean If checked, dependencies of uploaded Cargo crates which do not set an explicit value for &quot;registry&quot; will be assumed to be available from crates.io. If unchecked, dependencies with unspecified &quot;registry&quot; values will be assumed to be available in the registry being uploaded to. Uncheck this if you want to ensure that dependencies are only ever installed from Cloudsmith unless explicitly specified as belong to another registry. [optional]
useEntitlementsPrivilege UseEntitlementsPrivilegeEnum This defines the minimum level of privilege required for a user to see/use entitlement tokens with private repositories. If a user does not have the permission, they will only be able to download packages using other credentials, such as email/password via basic authentication. Use this if you want to force users to only use their user-based token, which is tied to their access (if removed, they can't use it). [optional]
useNoarchPackages Boolean If checked, noarch packages (if supported) are enabled in installations/configurations. A noarch package is one that is not tied to specific system architecture (like i686). [optional]
useSourcePackages Boolean If checked, source packages (if supported) are enabled in installations/configurations. A source package is one that contains source code rather than built binaries. [optional]
useVulnerabilityScanning Boolean If checked, vulnerability scanning will be enabled for all supported packages within this repository. [optional]
userEntitlementsEnabled Boolean If checked, users can use and manage their own user-specific entitlement token for the repository (if private). Otherwise, user-specific entitlements are disabled for all users. [optional]
viewStatistics ViewStatisticsEnum This defines the minimum level of privilege required for a user to view repository statistics, to include entitlement-based usage, if applicable. If a user does not have the permission, they won't be able to view any statistics, either via the UI, API or CLI. [optional]

Enum: BroadcastStateEnum

Name Value
OFF "Off"
PRIVATE "Private"
INTERNAL "Internal"
PUBLIC "Public"
OPEN_SOURCE "Open-Source"

Enum: ContentKindEnum

Name Value
STANDARD "Standard"
DISTRIBUTION "Distribution"
UPSTREAM "Upstream"

Enum: CopyPackagesEnum

Name Value
ADMIN "Admin"
WRITE "Write"
READ "Read"

Enum: DefaultPrivilegeEnum

Name Value
ADMIN "Admin"
WRITE "Write"
READ "Read"
NONE "None"

Enum: DeletePackagesEnum

Name Value
ADMIN "Admin"
WRITE "Write"

Enum: ManageEntitlementsPrivilegeEnum

Name Value
ADMIN "Admin"
WRITE "Write"
READ "Read"

Enum: MovePackagesEnum

Name Value
ADMIN "Admin"
WRITE "Write"
READ "Read"

Enum: ReplacePackagesEnum

Name Value
ADMIN "Admin"
WRITE "Write"

Enum: RepositoryTypeStrEnum

Name Value
PUBLIC "Public"
PRIVATE "Private"
OPEN_SOURCE "Open-Source"

Enum: ResyncPackagesEnum

Name Value
ADMIN "Admin"
WRITE "Write"

Enum: ScanPackagesEnum

Name Value
ADMIN "Admin"
WRITE "Write"
READ "Read"

Enum: UseEntitlementsPrivilegeEnum

Name Value
ADMIN "Admin"
WRITE "Write"
READ "Read"

Enum: ViewStatisticsEnum

Name Value
ADMIN "Admin"
WRITE "Write"
READ "Read"