Repositories¶
repositories
¶
RepositoryId
¶
Bases: str
Unique ID of a repository.
RepositoryAssetId
¶
Bases: str
Unique ID of a repository asset.
PackageId
¶
Bases: str
Unique ID of a package.
PackageVersionId
¶
Bases: str
Unique ID of a package version.
RepositoryS3Config
¶
Bases: BaseModel
Repository S3 config.
endpoint
class-attribute
instance-attribute
¶
endpoint = Field(
description="S3 endpoint (e.g., https://s3.amazonaws.com or https://minio.local:9000)."
)
region
class-attribute
instance-attribute
¶
region = Field(
default=None,
description="AWS region (required by AWS, may be NULL for MinIO/other providers).",
)
prefix
class-attribute
instance-attribute
¶
prefix = Field(
default=None,
description="Optional prefix inside the bucket to scope this repository.",
)
access_key_id
class-attribute
instance-attribute
¶
access_key_id = Field(
description="S3 access key ID (not sensitive, can be plain text).",
validation_alias="accessKeyId",
serialization_alias="accessKeyId",
)
secret_access_key
class-attribute
instance-attribute
¶
secret_access_key = Field(
default=None,
description="S3 secret access key (sensitive, will be stored encrypted).",
validation_alias="secretAccessKey",
serialization_alias="secretAccessKey",
)
ResolveRepositoryNameAction
¶
GetRepositoryDetailsAction
¶
Bases: BaseModel
Get information about a repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
GetRepositoryDetailsOutput
¶
Bases: BaseModel
Output of getting information about a repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
display_name
class-attribute
instance-attribute
¶
display_name = Field(
description="Display name of the repository.",
validation_alias="displayName",
serialization_alias="displayName",
)
public_name
class-attribute
instance-attribute
¶
public_name = Field(
default=None,
description="Name of the repository.",
validation_alias="publicName",
serialization_alias="publicName",
)
visibility
class-attribute
instance-attribute
¶
package_count
class-attribute
instance-attribute
¶
package_count = Field(
description="Number of packages in the repository.",
validation_alias="packageCount",
serialization_alias="packageCount",
)
asset_count
class-attribute
instance-attribute
¶
asset_count = Field(
description="Number of assets in the repository.",
validation_alias="assetCount",
serialization_alias="assetCount",
)
CreateRepositoryAction
¶
Bases: BaseModel
Create a new repository.
organization_id
class-attribute
instance-attribute
¶
organization_id = Field(
description="Organization to create the repository in.",
validation_alias="organizationId",
serialization_alias="organizationId",
)
visibility
class-attribute
instance-attribute
¶
visibility = Field(
default=None,
description="Visibility of the repository.\n\nDefault to private.",
)
CreateRepositorySuccess
¶
Bases: BaseModel
Successfully created a repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
DeleteRepositoryAction
¶
Bases: BaseModel
Delete a repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
SetRepositoryVisibilityAction
¶
Bases: BaseModel
Set the visibility of a repository.
SetRepositoryDisplayNameAction
¶
Bases: BaseModel
Set the display name of a repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
display_name
class-attribute
instance-attribute
¶
display_name = Field(
default=None,
description="New display name of the repository.",
validation_alias="displayName",
serialization_alias="displayName",
)
SetRepositoryPublicNameAction
¶
Bases: BaseModel
Set the public name of a repository.
Note: Setting the public name requires the public_repositories subscription feature.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
public_name
class-attribute
instance-attribute
¶
public_name = Field(
description="New public name of the repository.",
validation_alias="publicName",
serialization_alias="publicName",
)
QueryRepositoryPackagesAction
¶
Bases: BaseModel
Query the packages of a repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
QueryRepositoryPackagesOutput
¶
Bases: BaseModel
Output of querying the packages of a repository.
QueryRepositoryPackagesItem
¶
Bases: BaseModel
Package query item.
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
kind
class-attribute
instance-attribute
¶
created_at
class-attribute
instance-attribute
¶
created_at = Field(
description="Timestamp when the package was created.",
validation_alias="createdAt",
serialization_alias="createdAt",
)
QueryRepositoryAssetsAction
¶
Bases: BaseModel
Query the assets of a repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
QueryRepositoryAssetsOutput
¶
Bases: BaseModel
Output of querying the assets of a repository.
QueryRepositoryAssetsItem
¶
Bases: BaseModel
Asset query item.
asset_id
class-attribute
instance-attribute
¶
asset_id = Field(
description="ID of the asset.",
validation_alias="assetId",
serialization_alias="assetId",
)
QueryRepositoryProjectsAction
¶
Bases: BaseModel
Query repository projects.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
QueryRepositoryProjectsOutput
¶
Bases: BaseModel
Output of querying the projects of a repository.
QueryRepositoryProjectsItem
¶
ResolvePackageByPathAction
¶
ResolvePackageByPathSuccess
¶
Bases: BaseModel
Successfully resolved package by path.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
GetPackageDetailsAction
¶
Bases: BaseModel
Get information about a package.
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
GetPackageDetailsOutput
¶
Bases: BaseModel
Output of getting information about a package.
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
kind
class-attribute
instance-attribute
¶
version_count
class-attribute
instance-attribute
¶
version_count = Field(
description="Number of versions of the package.",
validation_alias="versionCount",
serialization_alias="versionCount",
)
metadata
class-attribute
instance-attribute
¶
CreatePackageAction
¶
Bases: BaseModel
Create a new package.
CreatePackageSuccess
¶
Bases: BaseModel
Successfully created a package.
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
DeletePackageAction
¶
Bases: BaseModel
Delete a package.
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
SetPackageMetadataAction
¶
Bases: BaseModel
Set metadata on a package.
SetPackageKindAction
¶
Bases: BaseModel
Set the kind of a package.
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
kind
class-attribute
instance-attribute
¶
kind = Field(
default=None,
description='New kind of the package (e.g., "rugix-app"), or null to clear.',
)
SetPackageNameAction
¶
Bases: BaseModel
Set the name of a package.
QueryPackageVersionsAction
¶
Bases: BaseModel
Query the versions of a package.
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
QueryPackageVersionsOutput
¶
Bases: BaseModel
Output of querying the versions of a package.
versions
class-attribute
instance-attribute
¶
QueryPackageVersionsItem
¶
Bases: BaseModel
Package version query item.
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
name
class-attribute
instance-attribute
¶
created_at
class-attribute
instance-attribute
¶
created_at = Field(
description="Timestamp when the package version was created.",
validation_alias="createdAt",
serialization_alias="createdAt",
)
PackageVersionTag
¶
AddTagItem
¶
Bases: BaseModel
Add tag item.
locked
class-attribute
instance-attribute
¶
locked = Field(
default=None,
description="Indicates whether the tag should be locked.\n\nDefault to false.",
)
reassign
class-attribute
instance-attribute
¶
reassign = Field(
default=None,
description="Indicates whether the tag should be reassigned, if it already exists.\n\nDefaults to true.",
)
RemoveTagItem
¶
Bases: BaseModel
Remove tag item.
PackageVersionAsset
¶
ResolvePackageVersionByPathAction
¶
Bases: BaseModel
Resolve a package version by its path.
ResolvePackageVersionByPathSuccess
¶
Bases: BaseModel
Successfully resolved package version by path.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
GetPackageVersionDetailsAction
¶
Bases: BaseModel
Get information about a package version.
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
GetPackageVersionDetailsOutput
¶
Bases: BaseModel
Output of getting information about a package version.
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
name
class-attribute
instance-attribute
¶
metadata
class-attribute
instance-attribute
¶
CreatePackageVersionAction
¶
Bases: BaseModel
Create a new package version.
CreatePackageVersionSuccess
¶
Bases: BaseModel
Package version creation has been successful.
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
DeletePackageVersionAction
¶
Bases: BaseModel
Delete a package version.
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
SetPackageVersionNameAction
¶
Bases: BaseModel
Set the name of a package version.
SetPackageVersionMetadataAction
¶
AddPackageVersionAssetAction
¶
Bases: BaseModel
Add an asset to a package version.
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
asset_id
class-attribute
instance-attribute
¶
asset_id = Field(
description="ID of the asset.",
validation_alias="assetId",
serialization_alias="assetId",
)
filename
class-attribute
instance-attribute
¶
metadata
class-attribute
instance-attribute
¶
metadata = Field(
default=None,
description="Optional metadata to associate with this asset in the version.",
)
RemovePackageVersionAssetAction
¶
Bases: BaseModel
Remove an asset from a package version.
SetPackageVersionAssetMetadataAction
¶
Bases: BaseModel
Set metadata on a package version asset.
TagPackageVersionAction
¶
UntagPackageVersionAction
¶
Bases: BaseModel
Remove tags from a version.
ResolvePackageVersionAssetByPathAction
¶
ResolvePackageVersionAssetByPathSuccess
¶
Bases: BaseModel
Successfully resolved version asset by path.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
package_id
class-attribute
instance-attribute
¶
package_id = Field(
description="ID of the package.",
validation_alias="packageId",
serialization_alias="packageId",
)
version_id
class-attribute
instance-attribute
¶
version_id = Field(
description="ID of the package version.",
validation_alias="versionId",
serialization_alias="versionId",
)
asset_id
class-attribute
instance-attribute
¶
asset_id = Field(
description="ID of the asset.",
validation_alias="assetId",
serialization_alias="assetId",
)
SetRepositoryS3ConfigAction
¶
Bases: BaseModel
Set the S3 configuration for the repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
s_3_config
class-attribute
instance-attribute
¶
s_3_config = Field(
description="S3 config for the repository.",
validation_alias="s3Config",
serialization_alias="s3Config",
)
GetRepositoryS3ConfigAction
¶
Bases: BaseModel
Get the S3 configuration for the repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
GetRepositoryS3ConfigOutput
¶
Bases: BaseModel
Output of getting the S3 configuration for the repository.
This intentionally does not include the secret access key.
s_3_config
class-attribute
instance-attribute
¶
s_3_config = Field(
description="S3 config for the repository.",
validation_alias="s3Config",
serialization_alias="s3Config",
)
GetAssetDetailsAction
¶
Bases: BaseModel
Get information about an asset.
asset_id
class-attribute
instance-attribute
¶
asset_id = Field(
description="ID of the asset.",
validation_alias="assetId",
serialization_alias="assetId",
)
GetAssetDetailsOutput
¶
Bases: BaseModel
Output of getting information about an asset.
asset_id
class-attribute
instance-attribute
¶
asset_id = Field(
description="ID of the asset.",
validation_alias="assetId",
serialization_alias="assetId",
)
reference_count
class-attribute
instance-attribute
¶
reference_count = Field(
description="Number of package versions that refer to the asset.",
validation_alias="referenceCount",
serialization_alias="referenceCount",
)
CreateAssetAction
¶
Bases: BaseModel
Create an asset.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
DeleteAssetAction
¶
Bases: BaseModel
Delete an asset.
asset_id
class-attribute
instance-attribute
¶
asset_id = Field(
description="ID of the asset.",
validation_alias="assetId",
serialization_alias="assetId",
)
IssueAssetDownloadUrlAction
¶
IssueAssetDownloadUrlOutput
¶
Bases: BaseModel
Output of issuing a URL for downloading an asset.
IssueAssetUploadUrlAction
¶
Bases: BaseModel
Issue a URL for uploading an asset.
asset_id
class-attribute
instance-attribute
¶
asset_id = Field(
description="ID of the asset to issue the URL for.",
validation_alias="assetId",
serialization_alias="assetId",
)
IssueAssetUploadUrlOutput
¶
Bases: BaseModel
Output of issuing a URL for uploading an asset.
QueryAuditLogEventsAction
¶
Bases: BaseModel
Query the audit log of the repository.
repository_id
class-attribute
instance-attribute
¶
repository_id = Field(
description="ID of the repository.",
validation_alias="repositoryId",
serialization_alias="repositoryId",
)
QueryAuditLogEventsOutput
¶
Bases: BaseModel
Output of querying the audit log of the repository.
RepositoryAssetStatus_Dangling
¶
Bases: RootModel[Literal['Dangling']]
RepositoryAssetStatus_Available
¶
Bases: RootModel[Literal['Available']]
RepositoryAssetStatus_Deleting
¶
Bases: RootModel[Literal['Deleting']]
RepositoryAssetStatus
¶
RepositoryAssetStatus = (
RepositoryAssetStatus_Dangling
| RepositoryAssetStatus_Available
| RepositoryAssetStatus_Deleting
)
RepositoryVisibility_Public
¶
Bases: RootModel[Literal['Public']]
RepositoryVisibility_Private
¶
Bases: RootModel[Literal['Private']]
RepositoryVisibility
¶
RepositoryVisibility = (
RepositoryVisibility_Public
| RepositoryVisibility_Private
)
ResolveRepositoryNameOutput_Found
¶
ResolveRepositoryNameOutput_NotFound
¶
Bases: BaseModel
ResolveRepositoryNameOutput
¶
ResolveRepositoryNameOutput = Annotated[
ResolveRepositoryNameOutput_Found
| ResolveRepositoryNameOutput_NotFound,
Discriminator("result"),
]
CreateRepositoryOutput_NameAlreadyExists
¶
Bases: BaseModel
CreateRepositoryOutput_Created
¶
Bases: CreateRepositorySuccess
CreateRepositoryOutput
¶
CreateRepositoryOutput = Annotated[
CreateRepositoryOutput_NameAlreadyExists
| CreateRepositoryOutput_Created,
Discriminator("result"),
]
SetRepositoryPublicNameOutput_NameAlreadyExists
¶
Bases: BaseModel
SetRepositoryPublicNameOutput_Success
¶
Bases: BaseModel
SetRepositoryPublicNameOutput
¶
SetRepositoryPublicNameOutput = Annotated[
SetRepositoryPublicNameOutput_NameAlreadyExists
| SetRepositoryPublicNameOutput_Success,
Discriminator("result"),
]
ResolvePackageByPathOutput_Found
¶
Bases: ResolvePackageByPathSuccess
ResolvePackageByPathOutput_NotFound
¶
Bases: BaseModel
ResolvePackageByPathOutput
¶
ResolvePackageByPathOutput = Annotated[
ResolvePackageByPathOutput_Found
| ResolvePackageByPathOutput_NotFound,
Discriminator("result"),
]
CreatePackageOutput_NameAlreadyExists
¶
Bases: BaseModel
CreatePackageOutput_Created
¶
Bases: CreatePackageSuccess
CreatePackageOutput
¶
CreatePackageOutput = Annotated[
CreatePackageOutput_NameAlreadyExists
| CreatePackageOutput_Created,
Discriminator("result"),
]
SetPackageNameOutput_NameAlreadyExists
¶
Bases: BaseModel
SetPackageNameOutput_Success
¶
Bases: BaseModel
SetPackageNameOutput
¶
SetPackageNameOutput = Annotated[
SetPackageNameOutput_NameAlreadyExists
| SetPackageNameOutput_Success,
Discriminator("result"),
]
ResolvePackageVersionByPathOutput_Found
¶
ResolvePackageVersionByPathOutput_NotFound
¶
Bases: BaseModel
ResolvePackageVersionByPathOutput
¶
ResolvePackageVersionByPathOutput = Annotated[
ResolvePackageVersionByPathOutput_Found
| ResolvePackageVersionByPathOutput_NotFound,
Discriminator("result"),
]
CreatePackageVersionOutput_Created
¶
Bases: CreatePackageVersionSuccess
AddPackageVersionAssetOutput_FilenameAlreadyExists
¶
Bases: BaseModel
AddPackageVersionAssetOutput_Added
¶
Bases: BaseModel
AddPackageVersionAssetOutput
¶
AddPackageVersionAssetOutput = Annotated[
AddPackageVersionAssetOutput_FilenameAlreadyExists
| AddPackageVersionAssetOutput_Added,
Discriminator("result"),
]
ResolvePackageVersionAssetByPathOutput_Found
¶
ResolvePackageVersionAssetByPathOutput_NotFound
¶
Bases: BaseModel
ResolvePackageVersionAssetByPathOutput
¶
ResolvePackageVersionAssetByPathOutput = Annotated[
ResolvePackageVersionAssetByPathOutput_Found
| ResolvePackageVersionAssetByPathOutput_NotFound,
Discriminator("result"),
]
CreateAssetOutput_AssetAlreadyExists
¶
CreateAssetOutput_Created
¶
CreateAssetOutput
¶
CreateAssetOutput = Annotated[
CreateAssetOutput_AssetAlreadyExists
| CreateAssetOutput_Created,
Discriminator("result"),
]