Added documentation for golint

examples/accounts/delete_account.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteAccountExample provides an example of how to delete an account from
+// Octopus Deploy through the Go API client.
 func DeleteAccountExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/action_templates/delete_action_template.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteActionTemplateExample provides an example of how to delete an action
+// template from Octopus Deploy through the Go API client.
 func DeleteActionTemplateExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/artifacts/delete_artifact.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteArtifactExample provides an example of how to delete an artifact from
+// Octopus Deploy through the Go API client.
 func DeleteArtifactExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/build_information/delete_build_information.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteBuildInformationExample provides an example of how to delete build
+// information from Octopus Deploy through the Go API client.
 func DeleteBuildInformationExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/certificates/delete_certificate.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteCertificateExample provides an example of how to delete a certificate
+// from Octopus Deploy through the Go API client.
 func DeleteCertificateExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/certificates/replace_certificate.go

@@ -10,7 +10,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
-// ReplaceCertificateExample shows how to replace an existing certificate using go-octopusdeploy.
+// ReplaceCertificateExample provides an example of how to replace an existing
+// certificate in Octopus Deploy through the Go API client.
 func ReplaceCertificateExample() {
 	var (
 		apiKey          string = "API-YOUR_API_KEY"

examples/channels/delete_channel.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteChannelExample provides an example of how to delete a channel from
+// Octopus Deploy through the Go API client.
 func DeleteChannelExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/lifecycles/delete_lifecycle.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteLifecycleExample provides an example of how to delete a lifecycle from
+// Octopus Deploy through the Go API client.
 func DeleteLifecycleExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/machine_policies/delete_machine_policy.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteMachinePolicyExample provides an example of how to delete a machine
+// policy from Octopus Deploy through the Go API client.
 func DeleteMachinePolicyExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/machines/delete_machine.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteMachineExample provides an example of how to delete a machine from
+// Octopus Deploy through the Go API client.
 func DeleteMachineExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/octopus_server_nodes/delete_octopus_server_node.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteOctopusServerNodeExample provides an example of how to delete an
+// Octopus server node from Octopus Deploy through the Go API client.
 func DeleteOctopusServerNodeExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/packages/delete_package.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeletePackageExample provides an example of how to delete a package from
+// Octopus Deploy through the Go API client.
 func DeletePackageExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/project_groups/delete_project_group.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteProjectGroupExample provides an example of how to delete a project
+// group from Octopus Deploy through the Go API client.
 func DeleteProjectGroupExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/project_triggers/delete_project_trigger.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteProjectTriggerExample provides an example of how to delete a project
+// trigger from Octopus Deploy through the Go API client.
 func DeleteProjectTriggerExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/projects/delete_project.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteProjectExample provides an example of how to delete a project from
+// Octopus Deploy through the Go API client.
 func DeleteProjectExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/proxies/delete_proxy.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteProxyExample provides an example of how to delete a proxy from
+// Octopus Deploy through the Go API client.
 func DeleteProxyExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/releases/delete_release.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteReleaseExample provides an example of how to delete a release from
+// Octopus Deploy through the Go API client.
 func DeleteReleaseExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/runbook_runs/delete_runbook_run.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteRunbookRunExample provides an example of how to delete a runbook run
+// from Octopus Deploy through the Go API client.
 func DeleteRunbookRunExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/runbook_snapshots/delete_runbook_snapshot.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteRunbookSnapshotExample provides an example of how to delete a runbook
+// snapshot from Octopus Deploy through the Go API client.
 func DeleteRunbookSnapshotExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/runbooks/create_runbook.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// CreateRunbookExample provides an example of how to create a runbook in
+// Octopus Deploy through the Go API client.
 func CreateRunbookExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/runbooks/delete_runbook.go

@@ -6,7 +6,8 @@ import (
 
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
-
+// DeleteRunbookExample provides an example of how to delete a runbook from
+// Octopus Deploy through the Go API client.
 func DeleteRunbookExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/runbooks/get_runbook_by_id.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// GetRunbookByIDExample provides an example of how to get a runbook from
+// Octopus Deploy by its ID through the Go API client.
 func GetRunbookByIDExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/scoped_user_roles/delete_scoped_user_role.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteScopedUserRoleExample provides an example of how to delete a scoped
+// user role from Octopus Deploy through the Go API client.
 func DeleteScopedUserRoleExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/spaces/create_space.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// CreateSpaceExample provides an example of how to create a space in Octopus
+// Deploy through the Go API client.
 func CreateSpaceExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/spaces/delete_space.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteSpaceExample provides an example of how to delete a space from Octopus
+// Deploy through the Go API client.
 func DeleteSpaceExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/spaces/get_space_by_id.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// GetSpaceByIDExample provides an example of how to get a space from Octopus
+// Deploy by its ID through the Go API client.
 func GetSpaceByIDExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/subscriptions/delete_subscription.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteSubscriptionExample provides an example of how to delete a
+// subscription from Octopus Deploy through the Go API client.
 func DeleteSubscriptionExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/tag_sets/delete_tag_set.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteTagSetExample provides an example of how to delete a tag set from
+// Octopus Deploy through the Go API client.
 func DeleteTagSetExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/teams/delete_team.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteTeamExample provides an example of how to delete a team from Octopus
+// Deploy through the Go API client.
 func DeleteTeamExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/tenants/delete_tenant.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteTenantExample provides an example of how to delete a tenant from
+// Octopus Deploy through the Go API client.
 func DeleteTenantExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/user_roles/delete_user_role.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteUserRoleExample provides an example of how to delete a user role from
+// Octopus Deploy through the Go API client.
 func DeleteUserRoleExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/users/delete_user.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteUserExample provides an example of how to delete a user from Octopus
+// Deploy through the Go API client.
 func DeleteUserExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/worker_pools/create_dynamic_worker_pool.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// CreateDynamicWorkerPoolExample provides an example of how to create a
+// dynamic worker pool Octopus Deploy through the Go API client.
 func CreateDynamicWorkerPoolExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/worker_pools/delete_worker_pool.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteWorkerPoolExample provides an example of how to delete a dynamic
+// worker pool from Octopus Deploy through the Go API client.
 func DeleteWorkerPoolExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"

examples/workers/delete_worker.go

@@ -7,6 +7,8 @@ import (
 	"github.com/OctopusDeploy/go-octopusdeploy/octopusdeploy"
 )
 
+// DeleteWorkerExample provides an example of how to delete a worker from
+// Octopus Deploy through the Go API client.
 func DeleteWorkerExample() {
 	var (
 		apiKey     string = "API-YOUR_API_KEY"