cloudsmith

package module
v0.0.35 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2024 License: Apache-2.0 Imports: 20 Imported by: 1

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.401.1
  • Package version: 0.0.35
  • 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 sw.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 sw.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 sw.ContextOperationServerIndices and sw.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

Class Method HTTP request Description
AuditLogApi AuditLogNamespaceList Get /audit-log/{owner}/ Lists audit log entries for a specific namespace.
AuditLogApi AuditLogRepoList Get /audit-log/{owner}/{repo}/ Lists audit log entries for a specific repository.
BadgesApi BadgesVersionList Get /badges/version/{owner}/{repo}/{package_format}/{package_name}/{package_version}/{package_identifiers}/ Get latest package version for a package or package group.
DistrosApi DistrosList Get /distros/ Get a list of all supported distributions.
DistrosApi DistrosRead Get /distros/{slug}/ View for viewing/listing distributions.
EntitlementsApi EntitlementsCreate Post /entitlements/{owner}/{repo}/ Create a specific entitlement in a repository.
EntitlementsApi EntitlementsDelete Delete /entitlements/{owner}/{repo}/{identifier}/ Delete a specific entitlement in a repository.
EntitlementsApi EntitlementsDisable Post /entitlements/{owner}/{repo}/{identifier}/disable/ Disable an entitlement token in a repository.
EntitlementsApi EntitlementsEnable Post /entitlements/{owner}/{repo}/{identifier}/enable/ Enable an entitlement token in a repository.
EntitlementsApi EntitlementsList Get /entitlements/{owner}/{repo}/ Get a list of all entitlements in a repository.
EntitlementsApi EntitlementsPartialUpdate Patch /entitlements/{owner}/{repo}/{identifier}/ Update a specific entitlement in a repository.
EntitlementsApi EntitlementsRead Get /entitlements/{owner}/{repo}/{identifier}/ Get a specific entitlement in a repository.
EntitlementsApi EntitlementsRefresh Post /entitlements/{owner}/{repo}/{identifier}/refresh/ Refresh an entitlement token in a repository.
EntitlementsApi EntitlementsReset Post /entitlements/{owner}/{repo}/{identifier}/reset/ Reset the statistics for an entitlement token in a repository.
EntitlementsApi EntitlementsSync Post /entitlements/{owner}/{repo}/sync/ Synchronise tokens from a source repository.
FilesApi FilesAbort Post /files/{owner}/{repo}/{identifier}/abort/ Abort a multipart file upload.
FilesApi FilesComplete Post /files/{owner}/{repo}/{identifier}/complete/ Complete a multipart file upload.
FilesApi FilesCreate Post /files/{owner}/{repo}/ Request URL(s) to upload new package file upload(s) to.
FilesApi FilesInfo Get /files/{owner}/{repo}/{identifier}/info/ Get upload information to perform a multipart file upload.
FilesApi FilesValidate Post /files/{owner}/{repo}/validate/ Validate parameters used for create.
FormatsApi FormatsList Get /formats/ Get a list of all supported package formats.
FormatsApi FormatsRead Get /formats/{slug}/ Get a specific supported package format.
MetricsApi MetricsEntitlementsAccountList Get /metrics/entitlements/{owner}/ View for listing entitlement token metrics, across an account.
MetricsApi MetricsEntitlementsRepoList Get /metrics/entitlements/{owner}/{repo}/ View for listing entitlement token metrics, for a repository.
MetricsApi MetricsPackagesList Get /metrics/packages/{owner}/{repo}/ View for listing package usage metrics, for a repository.
NamespacesApi NamespacesList Get /namespaces/ Get a list of all namespaces the user belongs to.
NamespacesApi NamespacesRead Get /namespaces/{slug}/ Views for working with namespaces.
OrgsApi OrgsDenyPolicyCreate Post /orgs/{org}/deny-policy/ Create a package deny policy.
OrgsApi OrgsDenyPolicyDelete Delete /orgs/{org}/deny-policy/{slug_perm}/ Delete a package deny policy.
OrgsApi OrgsDenyPolicyList Get /orgs/{org}/deny-policy/ Get a list of all package deny policies.
OrgsApi OrgsDenyPolicyPartialUpdate Patch /orgs/{org}/deny-policy/{slug_perm}/ Partially update a package deny policy.
OrgsApi OrgsDenyPolicyRead Get /orgs/{org}/deny-policy/{slug_perm}/ Get a package deny policy.
OrgsApi OrgsDenyPolicyUpdate Put /orgs/{org}/deny-policy/{slug_perm}/ Update a package deny policy.
OrgsApi OrgsInvitesCreate Post /orgs/{org}/invites/ Create an organization invite for a specific user
OrgsApi OrgsInvitesDelete Delete /orgs/{org}/invites/{slug_perm}/ Delete a specific organization invite
OrgsApi OrgsInvitesExtend Post /orgs/{org}/invites/{slug_perm}/extend/ Extend an organization invite.
OrgsApi OrgsInvitesList Get /orgs/{org}/invites/ Get a list of all invites for an organization.
OrgsApi OrgsInvitesPartialUpdate Patch /orgs/{org}/invites/{slug_perm}/ Update a specific organization invite.
OrgsApi OrgsInvitesResend Post /orgs/{org}/invites/{slug_perm}/resend/ Resend an organization invite.
OrgsApi OrgsLicensePolicyCreate Post /orgs/{org}/license-policy/ Create a package license policy.
OrgsApi OrgsLicensePolicyDelete Delete /orgs/{org}/license-policy/{slug_perm}/ Delete a package license policy.
OrgsApi OrgsLicensePolicyEvaluationCreate Post /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/ Create an evaluation request for this policy.
OrgsApi OrgsLicensePolicyEvaluationList Get /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/ List evaluation requests for this policy.
OrgsApi OrgsLicensePolicyEvaluationRead Get /orgs/{org}/license-policy/{policy_slug_perm}/evaluation/{slug_perm}/ Retrieve an evaluation request for this policy.
OrgsApi OrgsLicensePolicyList Get /orgs/{org}/license-policy/ Get a list of all package license policies.
OrgsApi OrgsLicensePolicyPartialUpdate Patch /orgs/{org}/license-policy/{slug_perm}/ Partially update a package license policy.
OrgsApi OrgsLicensePolicyRead Get /orgs/{org}/license-policy/{slug_perm}/ Get a package license policy.
OrgsApi OrgsLicensePolicyUpdate Put /orgs/{org}/license-policy/{slug_perm}/ Update a package license policy.
OrgsApi OrgsLicensePolicyViolationList Get /orgs/{org}/license-policy-violation/ List all current license policy violations for this Organization.
OrgsApi OrgsList Get /orgs/ Get a list of all the organizations you are associated with.
OrgsApi OrgsMembersDelete Delete /orgs/{org}/members/{member}/ Removes a member from the organization.
OrgsApi OrgsMembersList Get /orgs/{org}/members/ Get the details for all organization members.
OrgsApi OrgsMembersRead Get /orgs/{org}/members/{member}/ Get the details for a specific organization member.
OrgsApi OrgsMembersRefresh Post /orgs/{org}/members/{member}/refresh/ Refresh a member of the organization's API key.
OrgsApi OrgsMembersRemove Get /orgs/{org}/members/{member}/remove/ Removes a member from the organization (deprecated, use DELETE instead).
OrgsApi OrgsOpenidConnectCreate Post /orgs/{org}/openid-connect/ Create the OpenID Connect provider settings for the org.
OrgsApi OrgsOpenidConnectDelete Delete /orgs/{org}/openid-connect/{slug_perm}/ Delete a specific OpenID Connect provider setting for the org.
OrgsApi OrgsOpenidConnectList Get /orgs/{org}/openid-connect/ Retrieve the list of OpenID Connect provider settings for the org.
OrgsApi OrgsOpenidConnectPartialUpdate Patch /orgs/{org}/openid-connect/{slug_perm}/ Update a specific OpenID Connect provider setting for the org.
OrgsApi OrgsOpenidConnectRead Get /orgs/{org}/openid-connect/{slug_perm}/ Retrieve a specific OpenID Connect provider setting for the org.
OrgsApi OrgsOpenidConnectUpdate Put /orgs/{org}/openid-connect/{slug_perm}/ Update a specific OpenID Connect provider setting for the org.
OrgsApi OrgsRead Get /orgs/{org}/ Get the details for the specific organization.
OrgsApi OrgsSamlGroupSyncCreate Post /orgs/{org}/saml-group-sync/ Create a new SAML Group Sync mapping within an organization.
OrgsApi OrgsSamlGroupSyncDelete Delete /orgs/{org}/saml-group-sync/{slug_perm}/ Delete a SAML Group Sync mapping from an organization.
OrgsApi OrgsSamlGroupSyncDisable Post /orgs/{org}/saml-group-sync/disable/ Disable SAML Group Sync for this organization.
OrgsApi OrgsSamlGroupSyncEnable Post /orgs/{org}/saml-group-sync/enable/ Enable SAML Group Sync for this organization.
OrgsApi OrgsSamlGroupSyncList Get /orgs/{org}/saml-group-sync/ Get the details of all SAML Group Sync mapping within an organization.
OrgsApi OrgsSamlGroupSyncStatus Get /orgs/{org}/saml-group-sync/status/ Retrieve the SAML Group Sync status for this organization.
OrgsApi OrgsServicesCreate Post /orgs/{org}/services/ Create a service within an organization.
OrgsApi OrgsServicesDelete Delete /orgs/{org}/services/{service}/ Delete a specific service
OrgsApi OrgsServicesList Get /orgs/{org}/services/ Get a list of all services within an organization.
OrgsApi OrgsServicesPartialUpdate Patch /orgs/{org}/services/{service}/ Update a service within an organization.
OrgsApi OrgsServicesRead Get /orgs/{org}/services/{service}/ Retrieve details of a single service within an organization.
OrgsApi OrgsServicesRefresh Post /orgs/{org}/services/{service}/refresh/ Refresh service API token.
OrgsApi OrgsTeamsCreate Post /orgs/{org}/teams/ Create a team for this organization.
OrgsApi OrgsTeamsDelete Delete /orgs/{org}/teams/{team}/ Delete a specific team in a organization.
OrgsApi OrgsTeamsList Get /orgs/{org}/teams/ Get the details of all teams within an organization.
OrgsApi OrgsTeamsMembersCreate Post /orgs/{org}/teams/{team}/members Add users to a team.
OrgsApi OrgsTeamsMembersList Get /orgs/{org}/teams/{team}/members List all members for the team.
OrgsApi OrgsTeamsMembersUpdate Put /orgs/{org}/teams/{team}/members Replace all team members.
OrgsApi OrgsTeamsPartialUpdate Patch /orgs/{org}/teams/{team}/ Update a specific team in a organization.
OrgsApi OrgsTeamsRead Get /orgs/{org}/teams/{team}/ Get the details of a specific team within an organization.
OrgsApi OrgsVulnerabilityPolicyCreate Post /orgs/{org}/vulnerability-policy/ Create a package vulnerability policy.
OrgsApi OrgsVulnerabilityPolicyDelete Delete /orgs/{org}/vulnerability-policy/{slug_perm}/ Delete a package vulnerability policy.
OrgsApi OrgsVulnerabilityPolicyEvaluationCreate Post /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/ Create an evaluation request for this policy.
OrgsApi OrgsVulnerabilityPolicyEvaluationList Get /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/ List evaluation requests for this policy.
OrgsApi OrgsVulnerabilityPolicyEvaluationRead Get /orgs/{org}/vulnerability-policy/{policy_slug_perm}/evaluation/{slug_perm}/ Retrieve an evaluation request for this policy.
OrgsApi OrgsVulnerabilityPolicyList Get /orgs/{org}/vulnerability-policy/ Get a list of all package vulnerability policies.
OrgsApi OrgsVulnerabilityPolicyPartialUpdate Patch /orgs/{org}/vulnerability-policy/{slug_perm}/ Partially update a package vulnerability policy.
OrgsApi OrgsVulnerabilityPolicyRead Get /orgs/{org}/vulnerability-policy/{slug_perm}/ Get a package vulnerability policy.
OrgsApi OrgsVulnerabilityPolicyUpdate Put /orgs/{org}/vulnerability-policy/{slug_perm}/ Update a package vulnerability policy.
OrgsApi OrgsVulnerabilityPolicyViolationList Get /orgs/{org}/vulnerability-policy-violation/ List all current vulnerability policy violations for this Organization.
PackagesApi PackagesCopy Post /packages/{owner}/{repo}/{identifier}/copy/ Copy a package to another repository.
PackagesApi PackagesDelete Delete /packages/{owner}/{repo}/{identifier}/ Delete a specific package in a repository.
PackagesApi PackagesDependencies Get /packages/{owner}/{repo}/{identifier}/dependencies/ Get the list of dependencies for a package. Transitive dependencies are included where supported.
PackagesApi PackagesList Get /packages/{owner}/{repo}/ Get a list of all packages associated with repository.
PackagesApi PackagesMove Post /packages/{owner}/{repo}/{identifier}/move/ Move a package to another repository.
PackagesApi PackagesQuarantine Post /packages/{owner}/{repo}/{identifier}/quarantine/ Quarantine or restore a package.
PackagesApi PackagesRead Get /packages/{owner}/{repo}/{identifier}/ Get a specific package in a repository.
PackagesApi PackagesResync Post /packages/{owner}/{repo}/{identifier}/resync/ Schedule a package for resynchronisation.
PackagesApi PackagesScan Post /packages/{owner}/{repo}/{identifier}/scan/ Schedule a package for scanning.
PackagesApi PackagesStatus Get /packages/{owner}/{repo}/{identifier}/status/ Get the synchronization status for a package.
PackagesApi PackagesTag Post /packages/{owner}/{repo}/{identifier}/tag/ Add/Replace/Remove tags for a package.
PackagesApi PackagesUploadAlpine Post /packages/{owner}/{repo}/upload/alpine/ Create a new Alpine package
PackagesApi PackagesUploadCargo Post /packages/{owner}/{repo}/upload/cargo/ Create a new Cargo package
PackagesApi PackagesUploadCocoapods Post /packages/{owner}/{repo}/upload/cocoapods/ Create a new CocoaPods package
PackagesApi PackagesUploadComposer Post /packages/{owner}/{repo}/upload/composer/ Create a new Composer package
PackagesApi PackagesUploadConan Post /packages/{owner}/{repo}/upload/conan/ Create a new Conan package
PackagesApi PackagesUploadConda Post /packages/{owner}/{repo}/upload/conda/ Create a new Conda package
PackagesApi PackagesUploadCran Post /packages/{owner}/{repo}/upload/cran/ Create a new CRAN package
PackagesApi PackagesUploadDart Post /packages/{owner}/{repo}/upload/dart/ Create a new Dart package
PackagesApi PackagesUploadDeb Post /packages/{owner}/{repo}/upload/deb/ Create a new Debian package
PackagesApi PackagesUploadDocker Post /packages/{owner}/{repo}/upload/docker/ Create a new Docker package
PackagesApi PackagesUploadGo Post /packages/{owner}/{repo}/upload/go/ Create a new Go package
PackagesApi PackagesUploadHelm Post /packages/{owner}/{repo}/upload/helm/ Create a new Helm package
PackagesApi PackagesUploadHex Post /packages/{owner}/{repo}/upload/hex/ Create a new Hex package
PackagesApi PackagesUploadLuarocks Post /packages/{owner}/{repo}/upload/luarocks/ Create a new LuaRocks package
PackagesApi PackagesUploadMaven Post /packages/{owner}/{repo}/upload/maven/ Create a new Maven package
PackagesApi PackagesUploadNpm Post /packages/{owner}/{repo}/upload/npm/ Create a new npm package
PackagesApi PackagesUploadNuget Post /packages/{owner}/{repo}/upload/nuget/ Create a new NuGet package
PackagesApi PackagesUploadP2 Post /packages/{owner}/{repo}/upload/p2/ Create a new P2 package
PackagesApi PackagesUploadPython Post /packages/{owner}/{repo}/upload/python/ Create a new Python package
PackagesApi PackagesUploadRaw Post /packages/{owner}/{repo}/upload/raw/ Create a new Raw package
PackagesApi PackagesUploadRpm Post /packages/{owner}/{repo}/upload/rpm/ Create a new RedHat package
PackagesApi PackagesUploadRuby Post /packages/{owner}/{repo}/upload/ruby/ Create a new Ruby package
PackagesApi PackagesUploadSwift Post /packages/{owner}/{repo}/upload/swift/ Create a new Swift package
PackagesApi PackagesUploadTerraform Post /packages/{owner}/{repo}/upload/terraform/ Create a new Terraform package
PackagesApi PackagesUploadVagrant Post /packages/{owner}/{repo}/upload/vagrant/ Create a new Vagrant package
PackagesApi PackagesValidateUploadAlpine Post /packages/{owner}/{repo}/validate-upload/alpine/ Validate parameters for create Alpine package
PackagesApi PackagesValidateUploadCargo Post /packages/{owner}/{repo}/validate-upload/cargo/ Validate parameters for create Cargo package
PackagesApi PackagesValidateUploadCocoapods Post /packages/{owner}/{repo}/validate-upload/cocoapods/ Validate parameters for create CocoaPods package
PackagesApi PackagesValidateUploadComposer Post /packages/{owner}/{repo}/validate-upload/composer/ Validate parameters for create Composer package
PackagesApi PackagesValidateUploadConan Post /packages/{owner}/{repo}/validate-upload/conan/ Validate parameters for create Conan package
PackagesApi PackagesValidateUploadConda Post /packages/{owner}/{repo}/validate-upload/conda/ Validate parameters for create Conda package
PackagesApi PackagesValidateUploadCran Post /packages/{owner}/{repo}/validate-upload/cran/ Validate parameters for create CRAN package
PackagesApi PackagesValidateUploadDart Post /packages/{owner}/{repo}/validate-upload/dart/ Validate parameters for create Dart package
PackagesApi PackagesValidateUploadDeb Post /packages/{owner}/{repo}/validate-upload/deb/ Validate parameters for create Debian package
PackagesApi PackagesValidateUploadDocker Post /packages/{owner}/{repo}/validate-upload/docker/ Validate parameters for create Docker package
PackagesApi PackagesValidateUploadGo Post /packages/{owner}/{repo}/validate-upload/go/ Validate parameters for create Go package
PackagesApi PackagesValidateUploadHelm Post /packages/{owner}/{repo}/validate-upload/helm/ Validate parameters for create Helm package
PackagesApi PackagesValidateUploadHex Post /packages/{owner}/{repo}/validate-upload/hex/ Validate parameters for create Hex package
PackagesApi PackagesValidateUploadLuarocks Post /packages/{owner}/{repo}/validate-upload/luarocks/ Validate parameters for create LuaRocks package
PackagesApi PackagesValidateUploadMaven Post /packages/{owner}/{repo}/validate-upload/maven/ Validate parameters for create Maven package
PackagesApi PackagesValidateUploadNpm Post /packages/{owner}/{repo}/validate-upload/npm/ Validate parameters for create npm package
PackagesApi PackagesValidateUploadNuget Post /packages/{owner}/{repo}/validate-upload/nuget/ Validate parameters for create NuGet package
PackagesApi PackagesValidateUploadP2 Post /packages/{owner}/{repo}/validate-upload/p2/ Validate parameters for create P2 package
PackagesApi PackagesValidateUploadPython Post /packages/{owner}/{repo}/validate-upload/python/ Validate parameters for create Python package
PackagesApi PackagesValidateUploadRaw Post /packages/{owner}/{repo}/validate-upload/raw/ Validate parameters for create Raw package
PackagesApi PackagesValidateUploadRpm Post /packages/{owner}/{repo}/validate-upload/rpm/ Validate parameters for create RedHat package
PackagesApi PackagesValidateUploadRuby Post /packages/{owner}/{repo}/validate-upload/ruby/ Validate parameters for create Ruby package
PackagesApi PackagesValidateUploadSwift Post /packages/{owner}/{repo}/validate-upload/swift/ Validate parameters for create Swift package
PackagesApi PackagesValidateUploadTerraform Post /packages/{owner}/{repo}/validate-upload/terraform/ Validate parameters for create Terraform package
PackagesApi PackagesValidateUploadVagrant Post /packages/{owner}/{repo}/validate-upload/vagrant/ Validate parameters for create Vagrant package
QuotaApi QuotaHistoryRead Get /quota/history/{owner}/ Quota history for a given namespace.
QuotaApi QuotaOssHistoryRead Get /quota/oss/history/{owner}/ Open-source Quota history for a given namespace.
QuotaApi QuotaOssRead Get /quota/oss/{owner}/ Open-source Quota usage for a given namespace.
QuotaApi QuotaRead Get /quota/{owner}/ Quota usage for a given namespace.
RatesApi RatesLimitsList Get /rates/limits/ Endpoint to check rate limits for current user.
ReposApi ReposCreate Post /repos/{owner}/ Create a new repository in a given namespace.
ReposApi ReposDelete Delete /repos/{owner}/{identifier}/ Delete a repository in a given namespace.
ReposApi ReposGeoipDisable Post /repos/{owner}/{identifier}/geoip/disable/ Disable GeoIP for this repository.
ReposApi ReposGeoipEnable Post /repos/{owner}/{identifier}/geoip/enable/ Enable GeoIP for this repository.
ReposApi ReposGeoipPartialUpdate Patch /repos/{owner}/{identifier}/geoip Partially update repository geoip rules.
ReposApi ReposGeoipRead Get /repos/{owner}/{identifier}/geoip List all repository geoip rules.
ReposApi ReposGeoipTest Post /repos/{owner}/{identifier}/geoip/test/ Test a list of IP addresses against the repository's current GeoIP rules.
ReposApi ReposGeoipUpdate Put /repos/{owner}/{identifier}/geoip Replace repository geoip rules.
ReposApi ReposGpgCreate Post /repos/{owner}/{identifier}/gpg/ Set the active GPG key for the Repository.
ReposApi ReposGpgList Get /repos/{owner}/{identifier}/gpg/ Retrieve the active GPG key for the Repository.
ReposApi ReposGpgRegenerate Post /repos/{owner}/{identifier}/gpg/regenerate/ Regenerate GPG Key for the Repository.
ReposApi ReposNamespaceList Get /repos/{owner}/ Get a list of all repositories within a namespace.
ReposApi ReposPartialUpdate Patch /repos/{owner}/{identifier}/ Update details about a repository in a given namespace.
ReposApi ReposPrivilegesList Get /repos/{owner}/{identifier}/privileges List all explicity created privileges for the repository.
ReposApi ReposPrivilegesPartialUpdate Patch /repos/{owner}/{identifier}/privileges Modify privileges for the repository.
ReposApi ReposPrivilegesUpdate Put /repos/{owner}/{identifier}/privileges Replace all existing repository privileges with those specified.
ReposApi ReposRead Get /repos/{owner}/{identifier}/ Get a specific repository.
ReposApi ReposRsaCreate Post /repos/{owner}/{identifier}/rsa/ Set the active RSA key for the Repository.
ReposApi ReposRsaList Get /repos/{owner}/{identifier}/rsa/ Retrieve the active RSA key for the Repository.
ReposApi ReposRsaRegenerate Post /repos/{owner}/{identifier}/rsa/regenerate/ Regenerate RSA Key for the Repository.
ReposApi ReposUpstreamCranCreate Post /repos/{owner}/{identifier}/upstream/cran/ Create a CRAN upstream config for this repository.
ReposApi ReposUpstreamCranDelete Delete /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Delete a CRAN upstream config for this repository.
ReposApi ReposUpstreamCranList Get /repos/{owner}/{identifier}/upstream/cran/ List CRAN upstream configs for this repository.
ReposApi ReposUpstreamCranPartialUpdate Patch /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Partially update a CRAN upstream config for this repository.
ReposApi ReposUpstreamCranRead Get /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Retrieve a CRAN upstream config for this repository.
ReposApi ReposUpstreamCranUpdate Put /repos/{owner}/{identifier}/upstream/cran/{slug_perm}/ Update a CRAN upstream config for this repository.
ReposApi ReposUpstreamDartCreate Post /repos/{owner}/{identifier}/upstream/dart/ Create a Dart upstream config for this repository.
ReposApi ReposUpstreamDartDelete Delete /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Delete a Dart upstream config for this repository.
ReposApi ReposUpstreamDartList Get /repos/{owner}/{identifier}/upstream/dart/ List Dart upstream configs for this repository.
ReposApi ReposUpstreamDartPartialUpdate Patch /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Partially update a Dart upstream config for this repository.
ReposApi ReposUpstreamDartRead Get /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Retrieve a Dart upstream config for this repository.
ReposApi ReposUpstreamDartUpdate Put /repos/{owner}/{identifier}/upstream/dart/{slug_perm}/ Update a Dart upstream config for this repository.
ReposApi ReposUpstreamDebCreate Post /repos/{owner}/{identifier}/upstream/deb/ Create a Debian upstream config for this repository.
ReposApi ReposUpstreamDebDelete Delete /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Delete a Debian upstream config for this repository.
ReposApi ReposUpstreamDebList Get /repos/{owner}/{identifier}/upstream/deb/ List Debian upstream configs for this repository.
ReposApi ReposUpstreamDebPartialUpdate Patch /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Partially update a Debian upstream config for this repository.
ReposApi ReposUpstreamDebRead Get /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Retrieve a Debian upstream config for this repository.
ReposApi ReposUpstreamDebUpdate Put /repos/{owner}/{identifier}/upstream/deb/{slug_perm}/ Update a Debian upstream config for this repository.
ReposApi ReposUpstreamDockerCreate Post /repos/{owner}/{identifier}/upstream/docker/ Create a Docker upstream config for this repository.
ReposApi ReposUpstreamDockerDelete Delete /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Delete a Docker upstream config for this repository.
ReposApi ReposUpstreamDockerList Get /repos/{owner}/{identifier}/upstream/docker/ List Docker upstream configs for this repository.
ReposApi ReposUpstreamDockerPartialUpdate Patch /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Partially update a Docker upstream config for this repository.
ReposApi ReposUpstreamDockerRead Get /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Retrieve a Docker upstream config for this repository.
ReposApi ReposUpstreamDockerUpdate Put /repos/{owner}/{identifier}/upstream/docker/{slug_perm}/ Update a Docker upstream config for this repository.
ReposApi ReposUpstreamHelmCreate Post /repos/{owner}/{identifier}/upstream/helm/ Create a Helm upstream config for this repository.
ReposApi ReposUpstreamHelmDelete Delete /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Delete a Helm upstream config for this repository.
ReposApi ReposUpstreamHelmList Get /repos/{owner}/{identifier}/upstream/helm/ List Helm upstream configs for this repository.
ReposApi ReposUpstreamHelmPartialUpdate Patch /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Partially update a Helm upstream config for this repository.
ReposApi ReposUpstreamHelmRead Get /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Retrieve a Helm upstream config for this repository.
ReposApi ReposUpstreamHelmUpdate Put /repos/{owner}/{identifier}/upstream/helm/{slug_perm}/ Update a Helm upstream config for this repository.
ReposApi ReposUpstreamMavenCreate Post /repos/{owner}/{identifier}/upstream/maven/ Create a Maven upstream config for this repository.
ReposApi ReposUpstreamMavenDelete Delete /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Delete a Maven upstream config for this repository.
ReposApi ReposUpstreamMavenList Get /repos/{owner}/{identifier}/upstream/maven/ List Maven upstream configs for this repository.
ReposApi ReposUpstreamMavenPartialUpdate Patch /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Partially update a Maven upstream config for this repository.
ReposApi ReposUpstreamMavenRead Get /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Retrieve a Maven upstream config for this repository.
ReposApi ReposUpstreamMavenUpdate Put /repos/{owner}/{identifier}/upstream/maven/{slug_perm}/ Update a Maven upstream config for this repository.
ReposApi ReposUpstreamNpmCreate Post /repos/{owner}/{identifier}/upstream/npm/ Create a npm upstream config for this repository.
ReposApi ReposUpstreamNpmDelete Delete /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Delete a npm upstream config for this repository.
ReposApi ReposUpstreamNpmList Get /repos/{owner}/{identifier}/upstream/npm/ List npm upstream configs for this repository.
ReposApi ReposUpstreamNpmPartialUpdate Patch /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Partially update a npm upstream config for this repository.
ReposApi ReposUpstreamNpmRead Get /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Retrieve a npm upstream config for this repository.
ReposApi ReposUpstreamNpmUpdate Put /repos/{owner}/{identifier}/upstream/npm/{slug_perm}/ Update a npm upstream config for this repository.
ReposApi ReposUpstreamNugetCreate Post /repos/{owner}/{identifier}/upstream/nuget/ Create a NuGet upstream config for this repository.
ReposApi ReposUpstreamNugetDelete Delete /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Delete a NuGet upstream config for this repository.
ReposApi ReposUpstreamNugetList Get /repos/{owner}/{identifier}/upstream/nuget/ List NuGet upstream configs for this repository.
ReposApi ReposUpstreamNugetPartialUpdate Patch /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Partially update a NuGet upstream config for this repository.
ReposApi ReposUpstreamNugetRead Get /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Retrieve a NuGet upstream config for this repository.
ReposApi ReposUpstreamNugetUpdate Put /repos/{owner}/{identifier}/upstream/nuget/{slug_perm}/ Update a NuGet upstream config for this repository.
ReposApi ReposUpstreamPythonCreate Post /repos/{owner}/{identifier}/upstream/python/ Create a Python upstream config for this repository.
ReposApi ReposUpstreamPythonDelete Delete /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Delete a Python upstream config for this repository.
ReposApi ReposUpstreamPythonList Get /repos/{owner}/{identifier}/upstream/python/ List Python upstream configs for this repository.
ReposApi ReposUpstreamPythonPartialUpdate Patch /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Partially update a Python upstream config for this repository.
ReposApi ReposUpstreamPythonRead Get /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Retrieve a Python upstream config for this repository.
ReposApi ReposUpstreamPythonUpdate Put /repos/{owner}/{identifier}/upstream/python/{slug_perm}/ Update a Python upstream config for this repository.
ReposApi ReposUpstreamRpmCreate Post /repos/{owner}/{identifier}/upstream/rpm/ Create a RedHat upstream config for this repository.
ReposApi ReposUpstreamRpmDelete Delete /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Delete a RedHat upstream config for this repository.
ReposApi ReposUpstreamRpmList Get /repos/{owner}/{identifier}/upstream/rpm/ List RedHat upstream configs for this repository.
ReposApi ReposUpstreamRpmPartialUpdate Patch /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Partially update a RedHat upstream config for this repository.
ReposApi ReposUpstreamRpmRead Get /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Retrieve a RedHat upstream config for this repository.
ReposApi ReposUpstreamRpmUpdate Put /repos/{owner}/{identifier}/upstream/rpm/{slug_perm}/ Update a RedHat upstream config for this repository.
ReposApi ReposUpstreamRubyCreate Post /repos/{owner}/{identifier}/upstream/ruby/ Create a Ruby upstream config for this repository.
ReposApi ReposUpstreamRubyDelete Delete /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Delete a Ruby upstream config for this repository.
ReposApi ReposUpstreamRubyList Get /repos/{owner}/{identifier}/upstream/ruby/ List Ruby upstream configs for this repository.
ReposApi ReposUpstreamRubyPartialUpdate Patch /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Partially update a Ruby upstream config for this repository.
ReposApi ReposUpstreamRubyRead Get /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Retrieve a Ruby upstream config for this repository.
ReposApi ReposUpstreamRubyUpdate Put /repos/{owner}/{identifier}/upstream/ruby/{slug_perm}/ Update a Ruby upstream config for this repository.
ReposApi ReposUpstreamSwiftCreate Post /repos/{owner}/{identifier}/upstream/swift/ Create a Swift upstream config for this repository.
ReposApi ReposUpstreamSwiftDelete Delete /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Delete a Swift upstream config for this repository.
ReposApi ReposUpstreamSwiftList Get /repos/{owner}/{identifier}/upstream/swift/ List Swift upstream configs for this repository.
ReposApi ReposUpstreamSwiftPartialUpdate Patch /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Partially update a Swift upstream config for this repository.
ReposApi ReposUpstreamSwiftRead Get /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Retrieve a Swift upstream config for this repository.
ReposApi ReposUpstreamSwiftUpdate Put /repos/{owner}/{identifier}/upstream/swift/{slug_perm}/ Update a Swift upstream config for this repository.
ReposApi ReposUserList Get /repos/ Get a list of all repositories associated with current user.
StatusApi StatusCheckBasic Get /status/check/basic/ Endpoint to check basic API connectivity.
StorageRegionsApi StorageRegionsList Get /storage-regions/ Get a list of all available storage regions.
StorageRegionsApi StorageRegionsRead Get /storage-regions/{slug}/ Get a specific storage region.
UserApi UserSelf Get /user/self/ Provide a brief for the current user (if any).
UserApi UserTokenCreate Post /user/token/ Retrieve the API key/token for the authenticated user.
UsersApi UsersProfileRead Get /users/profile/{slug}/ Provide a brief for the specified user (if any).
VulnerabilitiesApi VulnerabilitiesNamespaceList Get /vulnerabilities/{owner}/ Lists scan results for a specific namespace.
VulnerabilitiesApi VulnerabilitiesPackageList Get /vulnerabilities/{owner}/{repo}/{package}/ Lists scan results for a specific package.
VulnerabilitiesApi VulnerabilitiesRead Get /vulnerabilities/{owner}/{repo}/{package}/{identifier}/ Get a scan result.
VulnerabilitiesApi VulnerabilitiesRepoList Get /vulnerabilities/{owner}/{repo}/ Lists scan results for a specific repository.
WebhooksApi WebhooksCreate Post /webhooks/{owner}/{repo}/ Create a specific webhook in a repository.
WebhooksApi WebhooksDelete Delete /webhooks/{owner}/{repo}/{identifier}/ Delete a specific webhook in a repository.
WebhooksApi WebhooksList Get /webhooks/{owner}/{repo}/ Get a list of all webhooks in a repository.
WebhooksApi WebhooksPartialUpdate Patch /webhooks/{owner}/{repo}/{identifier}/ Update a specific webhook in a repository.
WebhooksApi WebhooksRead Get /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: X-Api-Key and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"X-Api-Key": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)
basic
  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.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

support@cloudsmith.io

Documentation

Documentation is too large to display.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL