Categorygithub.com/cloudsmith-io/cloudsmith-api-go
repositorypackage
0.0.45
Repository: https://github.com/cloudsmith-io/cloudsmith-api-go.git
Documentation: pkg.go.dev

# README

Go API client for cloudsmith

The API to the Cloudsmith Service

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.654.0
  • Package version: 0.0.45
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://help.cloudsmith.io

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import cloudsmith "github.com/cloudsmith-io/cloudsmith-api-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value cloudsmith.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), cloudsmith.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value cloudsmith.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), cloudsmith.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using cloudsmith.ContextOperationServerIndices and cloudsmith.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), cloudsmith.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), cloudsmith.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.cloudsmith.io/v1

ClassMethodHTTP requestDescription
AuditLogApiAuditLogNamespaceListGet /audit-log/{owner}/Lists audit log entries for a specific namespace.
AuditLogApiAuditLogRepoListGet /audit-log/{owner}/{repo}/Lists audit log entries for a specific repository.
BadgesApiBadgesVersionListGet /badges/version/{owner}/{repo}/{package_format}/{package_name}/{package_version}/{package_identifiers}/Get latest package version for a package or package group.
DistrosApiDistrosListGet /distros/Get a list of all supported distributions.
DistrosApiDistrosReadGet /distros/{slug}/View for viewing/listing distributions.
EntitlementsApiEntitlementsCreatePost /entitlements/{owner}/{repo}/Create a specific entitlement in a repository.
EntitlementsApiEntitlementsDeleteDelete /entitlements/{owner}/{repo}/{identifier}/Delete a specific entitlement in a repository.
EntitlementsApiEntitlementsDisablePost /entitlements/{owner}/{repo}/{identifier}/disable/Disable an entitlement token in a repository.
EntitlementsApiEntitlementsEnablePost /entitlements/{owner}/{repo}/{identifier}/enable/Enable an entitlement token in a repository.
EntitlementsApiEntitlementsListGet /entitlements/{owner}/{repo}/Get a list of all entitlements in a repository.
EntitlementsApiEntitlementsPartialUpdatePatch /entitlements/{owner}/{repo}/{identifier}/Update a specific entitlement in a repository.
EntitlementsApiEntitlementsReadGet /entitlements/{owner}/{repo}/{identifier}/Get a specific entitlement in a repository.
EntitlementsApiEntitlementsRefreshPost /entitlements/{owner}/{repo}/{identifier}/refresh/Refresh an entitlement token in a repository.
EntitlementsApiEntitlementsResetPost /entitlements/{owner}/{repo}/{identifier}/reset/Reset the statistics for an entitlement token in a repository.
EntitlementsApiEntitlementsSyncPost /entitlements/{owner}/{repo}/sync/Synchronise tokens from a source repository.
FilesApiFilesAbortPost /files/{owner}/{repo}/{identifier}/abort/Abort a multipart file upload.
FilesApiFilesCompletePost /files/{owner}/{repo}/{identifier}/complete/Complete a multipart file upload.
FilesApiFilesCreatePost /files/{owner}/{repo}/Request URL(s) to upload new package file upload(s) to.
FilesApiFilesInfoGet /files/{owner}/{repo}/{identifier}/info/Get upload information to perform a multipart file upload.
FilesApiFilesValidatePost /files/{owner}/{repo}/validate/Validate parameters used for create.
FormatsApiFormatsListGet /formats/Get a list of all supported package formats.
FormatsApiFormatsReadGet /formats/{slug}/Get a specific supported package format.
MetricsApiMetricsEntitlementsAccountListGet /metrics/entitlements/{owner}/View for listing entitlement token metrics, across an account.
MetricsApiMetricsEntitlementsRepoListGet /metrics/entitlements/{owner}/{repo}/View for listing entitlement token metrics, for a repository.
MetricsApiMetricsPackagesListGet /metrics/packages/{owner}/{repo}/View for listing package usage metrics, for a repository.
NamespacesApiNamespacesListGet /namespaces/Get a list of all namespaces the user belongs to.
NamespacesApiNamespacesReadGet /namespaces/{slug}/Get a specific namespace that the user belongs to.
OrgsApiOrgsDeleteDelete /orgs/{org}/Delete the specified organization.
OrgsApiOrgsDenyPolicyCreatePost /orgs/{org}/deny-policy/Create a package deny policy.
OrgsApiOrgsDenyPolicyDeleteDelete /orgs/{org}/deny-policy/{slug_perm}/Delete a package deny policy.
OrgsApiOrgsDenyPolicyListGet /orgs/{org}/deny-policy/Get a list of all package deny policies.
OrgsApiOrgsDenyPolicyPartialUpdatePatch /orgs/{org}/deny-policy/{slug_perm}/Partially update a package deny policy.
OrgsApiOrgsDenyPolicyReadGet /orgs/{org}/deny-policy/{slug_perm}/Get a package deny policy.
OrgsApiOrgsDenyPolicyUpdatePut /orgs/{org}/deny-policy/{slug_perm}/Update a package deny policy.
OrgsApiOrgsInvitesCreatePost /orgs/{org}/invites/Create an organization invite for a specific user
OrgsApiOrgsInvitesDeleteDelete /orgs/{org}/invites/{slug_perm}/Delete a specific organization invite
OrgsApiOrgsInvitesExtendPost /orgs/{org}/invites/{slug_perm}/extend/Extend an organization invite.
OrgsApiOrgsInvitesListGet /orgs/{org}/invites/Get a list of all invites for an organization.
OrgsApiOrgsInvitesPartialUpdatePatch /orgs/{org}/invites/{slug_perm}/Update a specific organization invite.
OrgsApiOrgsInvitesResendPost /orgs/{org}/invites/{slug_perm}/resend/Resend an organization invite.
OrgsApiOrgsLicensePolicyCreatePost /orgs/{org}/license-policy/Create a package license policy.
OrgsApiOrgsLicensePolicyDeleteDelete /orgs/{org}/license-policy/{slug_perm}/Delete a package license policy.
OrgsApiOrgsLicensePolicyEvaluationCreatePost /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/Create an evaluation request for this policy.
OrgsApiOrgsLicensePolicyEvaluationListGet /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/List evaluation requests for this policy.
OrgsApiOrgsLicensePolicyEvaluationReadGet /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/{slug_perm}/Retrieve an evaluation request for this policy.
OrgsApiOrgsLicensePolicyListGet /orgs/{org}/license-policy/Get a list of all package license policies.
OrgsApiOrgsLicensePolicyPartialUpdatePatch /orgs/{org}/license-policy/{slug_perm}/Partially update a package license policy.
OrgsApiOrgsLicensePolicyReadGet /orgs/{org}/license-policy/{slug_perm}/Get a package license policy.
OrgsApiOrgsLicensePolicyUpdatePut /orgs/{org}/license-policy/{slug_perm}/Update a package license policy.
OrgsApiOrgsLicensePolicyViolationListGet /orgs/{org}/license-policy-violation/List all current license policy violations for this Organization.
OrgsApiOrgsListGet /orgs/Get a list of all the organizations you are associated with.
OrgsApiOrgsMembersDeleteDelete /orgs/{org}/members/{member}/Removes a member from the organization.
OrgsApiOrgsMembersListGet /orgs/{org}/members/Get the details for all organization members.
OrgsApiOrgsMembersPartialUpdatePatch /orgs/{org}/members/{member}/Views for working with organization members.
OrgsApiOrgsMembersReadGet /orgs/{org}/members/{member}/Get the details for a specific organization member.
OrgsApiOrgsMembersRefreshPost /orgs/{org}/members/{member}/refresh/Refresh a member of the organization's API key.
OrgsApiOrgsMembersRemoveGet /orgs/{org}/members/{member}/remove/Removes a member from the organization (deprecated, use DELETE instead).
OrgsApiOrgsMembersUpdateRolePatch /orgs/{org}/members/{member}/update-role/Update a member's role in the organization.
OrgsApiOrgsMembersUpdateVisibilityPatch /orgs/{org}/members/{member}/update-visibility/Update a member's visibility in the organization.
OrgsApiOrgsOpenidConnectCreatePost /orgs/{org}/openid-connect/Create the OpenID Connect provider settings for the org.
OrgsApiOrgsOpenidConnectDeleteDelete /orgs/{org}/openid-connect/{slug_perm}/Delete a specific OpenID Connect provider setting for the org.
OrgsApiOrgsOpenidConnectListGet /orgs/{org}/openid-connect/Retrieve the list of OpenID Connect provider settings for the org.
OrgsApiOrgsOpenidConnectPartialUpdatePatch /orgs/{org}/openid-connect/{slug_perm}/Update a specific OpenID Connect provider setting for the org.
OrgsApiOrgsOpenidConnectReadGet /orgs/{org}/openid-connect/{slug_perm}/Retrieve a specific OpenID Connect provider setting for the org.
OrgsApiOrgsOpenidConnectUpdatePut /orgs/{org}/openid-connect/{slug_perm}/Update a specific OpenID Connect provider setting for the org.
OrgsApiOrgsReadGet /orgs/{org}/Get the details for the specific organization.
OrgsApiOrgsSamlAuthenticationPartialUpdatePatch /orgs/{org}/saml-authenticationUpdate the SAML Authentication settings for this Organization.
OrgsApiOrgsSamlAuthenticationReadGet /orgs/{org}/saml-authenticationRetrieve the SAML Authentication settings for this Organization.
OrgsApiOrgsSamlGroupSyncCreatePost /orgs/{org}/saml-group-sync/Create a new SAML Group Sync mapping within an organization.
OrgsApiOrgsSamlGroupSyncDeleteDelete /orgs/{org}/saml-group-sync/{slug_perm}/Delete a SAML Group Sync mapping from an organization.
OrgsApiOrgsSamlGroupSyncDisablePost /orgs/{org}/saml-group-sync/disable/Disable SAML Group Sync for this organization.
OrgsApiOrgsSamlGroupSyncEnablePost /orgs/{org}/saml-group-sync/enable/Enable SAML Group Sync for this organization.
OrgsApiOrgsSamlGroupSyncListGet /orgs/{org}/saml-group-sync/Get the details of all SAML Group Sync mapping within an organization.
OrgsApiOrgsSamlGroupSyncStatusGet /orgs/{org}/saml-group-sync/status/Retrieve the SAML Group Sync status for this organization.
OrgsApiOrgsServicesCreatePost /orgs/{org}/services/Create a service within an organization.
OrgsApiOrgsServicesDeleteDelete /orgs/{org}/services/{service}/Delete a specific service
OrgsApiOrgsServicesListGet /orgs/{org}/services/Get a list of all services within an organization.
OrgsApiOrgsServicesPartialUpdatePatch /orgs/{org}/services/{service}/Update a service within an organization.
OrgsApiOrgsServicesReadGet /orgs/{org}/services/{service}/Retrieve details of a single service within an organization.
OrgsApiOrgsServicesRefreshPost /orgs/{org}/services/{service}/refresh/Refresh service API token.
OrgsApiOrgsTeamsCreatePost /orgs/{org}/teams/Create a team for this organization.
OrgsApiOrgsTeamsDeleteDelete /orgs/{org}/teams/{team}/Delete a specific team in a organization.
OrgsApiOrgsTeamsListGet /orgs/{org}/teams/Get the details of all teams within an organization.
OrgsApiOrgsTeamsMembersCreatePost /orgs/{org}/teams/{team}/membersAdd users to a team.
OrgsApiOrgsTeamsMembersListGet /orgs/{org}/teams/{team}/membersList all members for the team.
OrgsApiOrgsTeamsMembersUpdatePut /orgs/{org}/teams/{team}/membersReplace all team members.
OrgsApiOrgsTeamsPartialUpdatePatch /orgs/{org}/teams/{team}/Update a specific team in a organization.
OrgsApiOrgsTeamsReadGet /orgs/{org}/teams/{team}/Get the details of a specific team within an organization.
OrgsApiOrgsVulnerabilityPolicyCreatePost /orgs/{org}/vulnerability-policy/Create a package vulnerability policy.
OrgsApiOrgsVulnerabilityPolicyDeleteDelete /orgs/{org}/vulnerability-policy/{slug_perm}/Delete a package vulnerability policy.
OrgsApiOrgsVulnerabilityPolicyEvaluationCreatePost /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/Create an evaluation request for this policy.
OrgsApiOrgsVulnerabilityPolicyEvaluationListGet /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/List evaluation requests for this policy.
OrgsApiOrgsVulnerabilityPolicyEvaluationReadGet /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/{slug_perm}/Retrieve an evaluation request for this policy.
OrgsApiOrgsVulnerabilityPolicyListGet /orgs/{org}/vulnerability-policy/Get a list of all package vulnerability policies.
OrgsApiOrgsVulnerabilityPolicyPartialUpdatePatch /orgs/{org}/vulnerability-policy/{slug_perm}/Partially update a package vulnerability policy.
OrgsApiOrgsVulnerabilityPolicyReadGet /orgs/{org}/vulnerability-policy/{slug_perm}/Get a package vulnerability policy.
OrgsApiOrgsVulnerabilityPolicyUpdatePut /orgs/{org}/vulnerability-policy/{slug_perm}/Update a package vulnerability policy.
OrgsApiOrgsVulnerabilityPolicyViolationListGet /orgs/{org}/vulnerability-policy-violation/List all current vulnerability policy violations for this Organization.
PackagesApiPackagesCopyPost /packages/{owner}/{repo}/{identifier}/copy/Copy a package to another repository.
PackagesApiPackagesDeleteDelete /packages/{owner}/{repo}/{identifier}/Delete a specific package in a repository.
PackagesApiPackagesDependenciesGet /packages/{owner}/{repo}/{identifier}/dependencies/Get the list of dependencies for a package. Transitive dependencies are included where supported.
PackagesApiPackagesListGet /packages/{owner}/{repo}/Get a list of all packages associated with repository.
PackagesApiPackagesMovePost /packages/{owner}/{repo}/{identifier}/move/Move a package to another repository.
PackagesApiPackagesQuarantinePost /packages/{owner}/{repo}/{identifier}/quarantine/Quarantine or release a package.
PackagesApiPackagesReadGet /packages/{owner}/{repo}/{identifier}/Get a specific package in a repository.
PackagesApiPackagesResyncPost /packages/{owner}/{repo}/{identifier}/resync/Schedule a package for resynchronisation.
PackagesApiPackagesScanPost /packages/{owner}/{repo}/{identifier}/scan/Schedule a package for scanning.
PackagesApiPackagesStatusGet /packages/{owner}/{repo}/{identifier}/status/Get the synchronization status for a package.
PackagesApiPackagesTagPost /packages/{owner}/{repo}/{identifier}/tag/Add/Replace/Remove tags for a package.
PackagesApiPackagesUploadAlpinePost /packages/{owner}/{repo}/upload/alpine/Create a new Alpine package
PackagesApiPackagesUploadCargoPost /packages/{owner}/{repo}/upload/cargo/Create a new Cargo package
PackagesApiPackagesUploadCocoapodsPost /packages/{owner}/{repo}/upload/cocoapods/Create a new CocoaPods package
PackagesApiPackagesUploadComposerPost /packages/{owner}/{repo}/upload/composer/Create a new Composer package
PackagesApiPackagesUploadConanPost /packages/{owner}/{repo}/upload/conan/Create a new Conan package
PackagesApiPackagesUploadCondaPost /packages/{owner}/{repo}/upload/conda/Create a new Conda package
PackagesApiPackagesUploadCranPost /packages/{owner}/{repo}/upload/cran/Create a new CRAN package
PackagesApiPackagesUploadDartPost /packages/{owner}/{repo}/upload/dart/Create a new Dart package
PackagesApiPackagesUploadDebPost /packages/{owner}/{repo}/upload/deb/Create a new Debian package
PackagesApiPackagesUploadDockerPost /packages/{owner}/{repo}/upload/docker/Create a new Docker package
PackagesApiPackagesUploadGoPost /packages/{owner}/{repo}/upload/go/Create a new Go package
PackagesApiPackagesUploadHelmPost /packages/{owner}/{repo}/upload/helm/Create a new Helm package
PackagesApiPackagesUploadHexPost /packages/{owner}/{repo}/upload/hex/Create a new Hex package
PackagesApiPackagesUploadLuarocksPost /packages/{owner}/{repo}/upload/luarocks/Create a new LuaRocks package
PackagesApiPackagesUploadMavenPost /packages/{owner}/{repo}/upload/maven/Create a new Maven package
PackagesApiPackagesUploadNpmPost /packages/{owner}/{repo}/upload/npm/Create a new npm package
PackagesApiPackagesUploadNugetPost /packages/{owner}/{repo}/upload/nuget/Create a new NuGet package
PackagesApiPackagesUploadP2Post /packages/{owner}/{repo}/upload/p2/Create a new P2 package
PackagesApiPackagesUploadPythonPost /packages/{owner}/{repo}/upload/python/Create a new Python package
PackagesApiPackagesUploadRawPost /packages/{owner}/{repo}/upload/raw/Create a new Raw package
PackagesApiPackagesUploadRpmPost /packages/{owner}/{repo}/upload/rpm/Create a new RedHat package
PackagesApiPackagesUploadRubyPost /packages/{owner}/{repo}/upload/ruby/Create a new Ruby package
PackagesApiPackagesUploadSwiftPost /packages/{owner}/{repo}/upload/swift/Create a new Swift package
PackagesApiPackagesUploadTerraformPost /packages/{owner}/{repo}/upload/terraform/Create a new Terraform package
PackagesApiPackagesUploadVagrantPost /packages/{owner}/{repo}/upload/vagrant/Create a new Vagrant package
PackagesApiPackagesValidateUploadAlpinePost /packages/{owner}/{repo}/validate-upload/alpine/Validate parameters for create Alpine package
PackagesApiPackagesValidateUploadCargoPost /packages/{owner}/{repo}/validate-upload/cargo/Validate parameters for create Cargo package
PackagesApiPackagesValidateUploadCocoapodsPost /packages/{owner}/{repo}/validate-upload/cocoapods/Validate parameters for create CocoaPods package
PackagesApiPackagesValidateUploadComposerPost /packages/{owner}/{repo}/validate-upload/composer/Validate parameters for create Composer package
PackagesApiPackagesValidateUploadConanPost /packages/{owner}/{repo}/validate-upload/conan/Validate parameters for create Conan package
PackagesApiPackagesValidateUploadCondaPost /packages/{owner}/{repo}/validate-upload/conda/Validate parameters for create Conda package
PackagesApiPackagesValidateUploadCranPost /packages/{owner}/{repo}/validate-upload/cran/Validate parameters for create CRAN package
PackagesApiPackagesValidateUploadDartPost /packages/{owner}/{repo}/validate-upload/dart/Validate parameters for create Dart package
PackagesApiPackagesValidateUploadDebPost /packages/{owner}/{repo}/validate-upload/deb/Validate parameters for create Debian package
PackagesApiPackagesValidateUploadDockerPost /packages/{owner}/{repo}/validate-upload/docker/Validate parameters for create Docker package
PackagesApiPackagesValidateUploadGoPost /packages/{owner}/{repo}/validate-upload/go/Validate parameters for create Go package
PackagesApiPackagesValidateUploadHelmPost /packages/{owner}/{repo}/validate-upload/helm/Validate parameters for create Helm package
PackagesApiPackagesValidateUploadHexPost /packages/{owner}/{repo}/validate-upload/hex/Validate parameters for create Hex package
PackagesApiPackagesValidateUploadLuarocksPost /packages/{owner}/{repo}/validate-upload/luarocks/Validate parameters for create LuaRocks package
PackagesApiPackagesValidateUploadMavenPost /packages/{owner}/{repo}/validate-upload/maven/Validate parameters for create Maven package
PackagesApiPackagesValidateUploadNpmPost /packages/{owner}/{repo}/validate-upload/npm/Validate parameters for create npm package
PackagesApiPackagesValidateUploadNugetPost /packages/{owner}/{repo}/validate-upload/nuget/Validate parameters for create NuGet package
PackagesApiPackagesValidateUploadP2Post /packages/{owner}/{repo}/validate-upload/p2/Validate parameters for create P2 package
PackagesApiPackagesValidateUploadPythonPost /packages/{owner}/{repo}/validate-upload/python/Validate parameters for create Python package
PackagesApiPackagesValidateUploadRawPost /packages/{owner}/{repo}/validate-upload/raw/Validate parameters for create Raw package
PackagesApiPackagesValidateUploadRpmPost /packages/{owner}/{repo}/validate-upload/rpm/Validate parameters for create RedHat package
PackagesApiPackagesValidateUploadRubyPost /packages/{owner}/{repo}/validate-upload/ruby/Validate parameters for create Ruby package
PackagesApiPackagesValidateUploadSwiftPost /packages/{owner}/{repo}/validate-upload/swift/Validate parameters for create Swift package
PackagesApiPackagesValidateUploadTerraformPost /packages/{owner}/{repo}/validate-upload/terraform/Validate parameters for create Terraform package
PackagesApiPackagesValidateUploadVagrantPost /packages/{owner}/{repo}/validate-upload/vagrant/Validate parameters for create Vagrant package
QuotaApiQuotaHistoryReadGet /quota/history/{owner}/Quota history for a given namespace.
QuotaApiQuotaOssHistoryReadGet /quota/oss/history/{owner}/Open-source Quota history for a given namespace.
QuotaApiQuotaOssReadGet /quota/oss/{owner}/Open-source Quota usage for a given namespace.
QuotaApiQuotaReadGet /quota/{owner}/Quota usage for a given namespace.
RatesApiRatesLimitsListGet /rates/limits/Endpoint to check rate limits for current user.
ReposApiApiReposGeoipStatusGet /repos/{owner}/{identifier}/geoip/status/Retrieve the GeoIP status for this repository.
ReposApiRepoRetentionPartialUpdatePatch /repos/{owner}/{repo}/retention/Update the retention rules for the repository.
ReposApiRepoRetentionReadGet /repos/{owner}/{repo}/retention/Retrieve the retention rules for the repository.
ReposApiReposCreatePost /repos/{owner}/Create a new repository in a given namespace.
ReposApiReposDeleteDelete /repos/{owner}/{identifier}/Delete a repository in a given namespace.
ReposApiReposEcdsaCreatePost /repos/{owner}/{identifier}/ecdsa/Set the active ECDSA key for the Repository.
ReposApiReposEcdsaListGet /repos/{owner}/{identifier}/ecdsa/Retrieve the active ECDSA key for the Repository.
ReposApiReposEcdsaRegeneratePost /repos/{owner}/{identifier}/ecdsa/regenerate/Regenerate ECDSA Key for the Repository.
ReposApiReposGeoipDisablePost /repos/{owner}/{identifier}/geoip/disable/Disable GeoIP for this repository.
ReposApiReposGeoipEnablePost /repos/{owner}/{identifier}/geoip/enable/Enable GeoIP for this repository.
ReposApiReposGeoipPartialUpdatePatch /repos/{owner}/{identifier}/geoipPartially update repository geoip rules.
ReposApiReposGeoipReadGet /repos/{owner}/{identifier}/geoipList all repository geoip rules.
ReposApiReposGeoipTestPost /repos/{owner}/{identifier}/geoip/test/Test a list of IP addresses against the repository's current GeoIP rules.
ReposApiReposGeoipUpdatePut /repos/{owner}/{identifier}/geoipReplace repository geoip rules.
ReposApiReposGpgCreatePost /repos/{owner}/{identifier}/gpg/Set the active GPG key for the Repository.
ReposApiReposGpgListGet /repos/{owner}/{identifier}/gpg/Retrieve the active GPG key for the Repository.
ReposApiReposGpgRegeneratePost /repos/{owner}/{identifier}/gpg/regenerate/Regenerate GPG Key for the Repository.
ReposApiReposNamespaceListGet /repos/{owner}/Get a list of all repositories within a namespace.
ReposApiReposPartialUpdatePatch /repos/{owner}/{identifier}/Update details about a repository in a given namespace.
ReposApiReposPrivilegesListGet /repos/{owner}/{identifier}/privilegesList all explicity created privileges for the repository.
ReposApiReposPrivilegesPartialUpdatePatch /repos/{owner}/{identifier}/privilegesModify privileges for the repository.
ReposApiReposPrivilegesUpdatePut /repos/{owner}/{identifier}/privilegesReplace all existing repository privileges with those specified.
ReposApiReposReadGet /repos/{owner}/{identifier}/Get a specific repository.
ReposApiReposRsaCreatePost /repos/{owner}/{identifier}/rsa/Set the active RSA key for the Repository.
ReposApiReposRsaListGet /repos/{owner}/{identifier}/rsa/Retrieve the active RSA key for the Repository.
ReposApiReposRsaRegeneratePost /repos/{owner}/{identifier}/rsa/regenerate/Regenerate RSA Key for the Repository.
ReposApiReposTransferRegionPost /repos/{owner}/{repo}/transfer-region/Transfer a repository to a different region.
ReposApiReposUpstreamComposerCreatePost /repos/{owner}/{identifier}/upstream/composer/Create a Composer upstream config for this repository.
ReposApiReposUpstreamComposerDeleteDelete /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/Delete a Composer upstream config for this repository.
ReposApiReposUpstreamComposerListGet /repos/{owner}/{identifier}/upstream/composer/List Composer upstream configs for this repository.
ReposApiReposUpstreamComposerPartialUpdatePatch /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/Partially update a Composer upstream config for this repository.
ReposApiReposUpstreamComposerReadGet /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/Retrieve a Composer upstream config for this repository.
ReposApiReposUpstreamComposerUpdatePut /repos/{owner}/{identifier}/upstream/composer/{slug_perm}/Update a Composer upstream config for this repository.
ReposApiReposUpstreamCranCreatePost /repos/{owner}/{identifier}/upstream/cran/Create a CRAN upstream config for this repository.
ReposApiReposUpstreamCranDeleteDelete /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/Delete a CRAN upstream config for this repository.
ReposApiReposUpstreamCranListGet /repos/{owner}/{identifier}/upstream/cran/List CRAN upstream configs for this repository.
ReposApiReposUpstreamCranPartialUpdatePatch /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/Partially update a CRAN upstream config for this repository.
ReposApiReposUpstreamCranReadGet /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/Retrieve a CRAN upstream config for this repository.
ReposApiReposUpstreamCranUpdatePut /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/Update a CRAN upstream config for this repository.
ReposApiReposUpstreamDartCreatePost /repos/{owner}/{identifier}/upstream/dart/Create a Dart upstream config for this repository.
ReposApiReposUpstreamDartDeleteDelete /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/Delete a Dart upstream config for this repository.
ReposApiReposUpstreamDartListGet /repos/{owner}/{identifier}/upstream/dart/List Dart upstream configs for this repository.
ReposApiReposUpstreamDartPartialUpdatePatch /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/Partially update a Dart upstream config for this repository.
ReposApiReposUpstreamDartReadGet /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/Retrieve a Dart upstream config for this repository.
ReposApiReposUpstreamDartUpdatePut /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/Update a Dart upstream config for this repository.
ReposApiReposUpstreamDebCreatePost /repos/{owner}/{identifier}/upstream/deb/Create a Debian upstream config for this repository.
ReposApiReposUpstreamDebDeleteDelete /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/Delete a Debian upstream config for this repository.
ReposApiReposUpstreamDebListGet /repos/{owner}/{identifier}/upstream/deb/List Debian upstream configs for this repository.
ReposApiReposUpstreamDebPartialUpdatePatch /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/Partially update a Debian upstream config for this repository.
ReposApiReposUpstreamDebReadGet /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/Retrieve a Debian upstream config for this repository.
ReposApiReposUpstreamDebUpdatePut /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/Update a Debian upstream config for this repository.
ReposApiReposUpstreamDockerCreatePost /repos/{owner}/{identifier}/upstream/docker/Create a Docker upstream config for this repository.
ReposApiReposUpstreamDockerDeleteDelete /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/Delete a Docker upstream config for this repository.
ReposApiReposUpstreamDockerListGet /repos/{owner}/{identifier}/upstream/docker/List Docker upstream configs for this repository.
ReposApiReposUpstreamDockerPartialUpdatePatch /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/Partially update a Docker upstream config for this repository.
ReposApiReposUpstreamDockerReadGet /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/Retrieve a Docker upstream config for this repository.
ReposApiReposUpstreamDockerUpdatePut /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/Update a Docker upstream config for this repository.
ReposApiReposUpstreamHelmCreatePost /repos/{owner}/{identifier}/upstream/helm/Create a Helm upstream config for this repository.
ReposApiReposUpstreamHelmDeleteDelete /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/Delete a Helm upstream config for this repository.
ReposApiReposUpstreamHelmListGet /repos/{owner}/{identifier}/upstream/helm/List Helm upstream configs for this repository.
ReposApiReposUpstreamHelmPartialUpdatePatch /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/Partially update a Helm upstream config for this repository.
ReposApiReposUpstreamHelmReadGet /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/Retrieve a Helm upstream config for this repository.
ReposApiReposUpstreamHelmUpdatePut /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/Update a Helm upstream config for this repository.
ReposApiReposUpstreamHexCreatePost /repos/{owner}/{identifier}/upstream/hex/Create a Hex upstream config for this repository.
ReposApiReposUpstreamHexDeleteDelete /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/Delete a Hex upstream config for this repository.
ReposApiReposUpstreamHexListGet /repos/{owner}/{identifier}/upstream/hex/List Hex upstream configs for this repository.
ReposApiReposUpstreamHexPartialUpdatePatch /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/Partially update a Hex upstream config for this repository.
ReposApiReposUpstreamHexReadGet /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/Retrieve a Hex upstream config for this repository.
ReposApiReposUpstreamHexUpdatePut /repos/{owner}/{identifier}/upstream/hex/{slug_perm}/Update a Hex upstream config for this repository.
ReposApiReposUpstreamMavenCreatePost /repos/{owner}/{identifier}/upstream/maven/Create a Maven upstream config for this repository.
ReposApiReposUpstreamMavenDeleteDelete /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/Delete a Maven upstream config for this repository.
ReposApiReposUpstreamMavenListGet /repos/{owner}/{identifier}/upstream/maven/List Maven upstream configs for this repository.
ReposApiReposUpstreamMavenPartialUpdatePatch /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/Partially update a Maven upstream config for this repository.
ReposApiReposUpstreamMavenReadGet /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/Retrieve a Maven upstream config for this repository.
ReposApiReposUpstreamMavenUpdatePut /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/Update a Maven upstream config for this repository.
ReposApiReposUpstreamNpmCreatePost /repos/{owner}/{identifier}/upstream/npm/Create a npm upstream config for this repository.
ReposApiReposUpstreamNpmDeleteDelete /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/Delete a npm upstream config for this repository.
ReposApiReposUpstreamNpmListGet /repos/{owner}/{identifier}/upstream/npm/List npm upstream configs for this repository.
ReposApiReposUpstreamNpmPartialUpdatePatch /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/Partially update a npm upstream config for this repository.
ReposApiReposUpstreamNpmReadGet /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/Retrieve a npm upstream config for this repository.
ReposApiReposUpstreamNpmUpdatePut /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/Update a npm upstream config for this repository.
ReposApiReposUpstreamNugetCreatePost /repos/{owner}/{identifier}/upstream/nuget/Create a NuGet upstream config for this repository.
ReposApiReposUpstreamNugetDeleteDelete /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/Delete a NuGet upstream config for this repository.
ReposApiReposUpstreamNugetListGet /repos/{owner}/{identifier}/upstream/nuget/List NuGet upstream configs for this repository.
ReposApiReposUpstreamNugetPartialUpdatePatch /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/Partially update a NuGet upstream config for this repository.
ReposApiReposUpstreamNugetReadGet /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/Retrieve a NuGet upstream config for this repository.
ReposApiReposUpstreamNugetUpdatePut /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/Update a NuGet upstream config for this repository.
ReposApiReposUpstreamPythonCreatePost /repos/{owner}/{identifier}/upstream/python/Create a Python upstream config for this repository.
ReposApiReposUpstreamPythonDeleteDelete /repos/{owner}/{identifier}/upstream/python/{slug_perm}/Delete a Python upstream config for this repository.
ReposApiReposUpstreamPythonListGet /repos/{owner}/{identifier}/upstream/python/List Python upstream configs for this repository.
ReposApiReposUpstreamPythonPartialUpdatePatch /repos/{owner}/{identifier}/upstream/python/{slug_perm}/Partially update a Python upstream config for this repository.
ReposApiReposUpstreamPythonReadGet /repos/{owner}/{identifier}/upstream/python/{slug_perm}/Retrieve a Python upstream config for this repository.
ReposApiReposUpstreamPythonUpdatePut /repos/{owner}/{identifier}/upstream/python/{slug_perm}/Update a Python upstream config for this repository.
ReposApiReposUpstreamRpmCreatePost /repos/{owner}/{identifier}/upstream/rpm/Create a RedHat upstream config for this repository.
ReposApiReposUpstreamRpmDeleteDelete /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/Delete a RedHat upstream config for this repository.
ReposApiReposUpstreamRpmListGet /repos/{owner}/{identifier}/upstream/rpm/List RedHat upstream configs for this repository.
ReposApiReposUpstreamRpmPartialUpdatePatch /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/Partially update a RedHat upstream config for this repository.
ReposApiReposUpstreamRpmReadGet /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/Retrieve a RedHat upstream config for this repository.
ReposApiReposUpstreamRpmUpdatePut /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/Update a RedHat upstream config for this repository.
ReposApiReposUpstreamRubyCreatePost /repos/{owner}/{identifier}/upstream/ruby/Create a Ruby upstream config for this repository.
ReposApiReposUpstreamRubyDeleteDelete /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/Delete a Ruby upstream config for this repository.
ReposApiReposUpstreamRubyListGet /repos/{owner}/{identifier}/upstream/ruby/List Ruby upstream configs for this repository.
ReposApiReposUpstreamRubyPartialUpdatePatch /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/Partially update a Ruby upstream config for this repository.
ReposApiReposUpstreamRubyReadGet /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/Retrieve a Ruby upstream config for this repository.
ReposApiReposUpstreamRubyUpdatePut /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/Update a Ruby upstream config for this repository.
ReposApiReposUpstreamSwiftCreatePost /repos/{owner}/{identifier}/upstream/swift/Create a Swift upstream config for this repository.
ReposApiReposUpstreamSwiftDeleteDelete /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/Delete a Swift upstream config for this repository.
ReposApiReposUpstreamSwiftListGet /repos/{owner}/{identifier}/upstream/swift/List Swift upstream configs for this repository.
ReposApiReposUpstreamSwiftPartialUpdatePatch /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/Partially update a Swift upstream config for this repository.
ReposApiReposUpstreamSwiftReadGet /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/Retrieve a Swift upstream config for this repository.
ReposApiReposUpstreamSwiftUpdatePut /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/Update a Swift upstream config for this repository.
ReposApiReposUserListGet /repos/Get a list of all repositories associated with current user.
ReposApiReposX509EcdsaListGet /repos/{owner}/{identifier}/x509-ecdsa/Retrieve the active X.509 ECDSA certificate for the Repository.
ReposApiReposX509RsaListGet /repos/{owner}/{identifier}/x509-rsa/Retrieve the active X.509 RSA certificate for the Repository.
StatusApiStatusCheckBasicGet /status/check/basic/Endpoint to check basic API connectivity.
StorageRegionsApiStorageRegionsListGet /storage-regions/Get a list of all available storage regions.
StorageRegionsApiStorageRegionsReadGet /storage-regions/{slug}/Get a specific storage region.
UserApiUserSelfGet /user/self/Provide a brief for the current user (if any).
UserApiUserTokenCreatePost /user/token/Retrieve/Create API key/token for the authenticated user.
UsersApiUsersProfileReadGet /users/profile/{slug}/Provide a brief for the specified user (if any).
VulnerabilitiesApiVulnerabilitiesNamespaceListGet /vulnerabilities/{owner}/Lists scan results for a specific namespace.
VulnerabilitiesApiVulnerabilitiesPackageListGet /vulnerabilities/{owner}/{repo}/{package}/Lists scan results for a specific package.
VulnerabilitiesApiVulnerabilitiesReadGet /vulnerabilities/{owner}/{repo}/{package}/{identifier}/Get a scan result.
VulnerabilitiesApiVulnerabilitiesRepoListGet /vulnerabilities/{owner}/{repo}/Lists scan results for a specific repository.
WebhooksApiWebhooksCreatePost /webhooks/{owner}/{repo}/Create a specific webhook in a repository.
WebhooksApiWebhooksDeleteDelete /webhooks/{owner}/{repo}/{identifier}/Delete a specific webhook in a repository.
WebhooksApiWebhooksListGet /webhooks/{owner}/{repo}/Get a list of all webhooks in a repository.
WebhooksApiWebhooksPartialUpdatePatch /webhooks/{owner}/{repo}/{identifier}/Update a specific webhook in a repository.
WebhooksApiWebhooksReadGet /webhooks/{owner}/{repo}/{identifier}/Views for working with repository webhooks.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apikey

  • Type: API key
  • API key parameter name: X-Api-Key
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: apikey and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		cloudsmith.ContextAPIKeys,
		map[string]cloudsmith.APIKey{
			"apikey": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

basic

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), cloudsmith.ContextBasicAuth, cloudsmith.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]