# Packages

No description provided by the author

# README

Go API client for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

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 openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

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(), openapi.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(), openapi.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(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost:5516

ClassMethodHTTP requestDescription
ActivityLogsApiGetActivityLogsGet /api/v1/activities/{containerId}
ApplicationApiCreateApplicationPost /api/v1/applications
ApplicationApiDeleteApplicationDelete /api/v1/applications/{applicationId}
ApplicationApiGetApplicationGet /api/v1/applications/{applicationId}
ApplicationApiSearchApplicationsPost /api/v1/applications/search
ApplicationApiUpdateApplicationPut /api/v1/applications/{applicationId}
ConfigurationApiAddConfigurationPost /api/v1/config
ConfigurationApiAddGlobalVariablePost /api/v1/config/Configuration/variables/global
ConfigurationApiCheckStatusPost /api/v1/config/status
ConfigurationApiCheckStatus1Post /api/v1/config/{configurationId}/status
ConfigurationApiDeleteConfigurationDelete /api/v1/config/{configurationId}
ConfigurationApiDeleteGlobalVariableDelete /api/v1/config/{variableId}
ConfigurationApiGetConfigurationGet /api/v1/config/{configurationId}
ConfigurationApiGetGlobalVariableGet /api/v1/config/{variableId}
ConfigurationApiGetGlobalVariableValuesGet /api/v1/config/Configuration/variableValues/global
ConfigurationApiGetGlobalVariablesGet /api/v1/config/Configuration/variables/global
ConfigurationApiGetSystemMessageGet /api/v1/config/system-message
ConfigurationApiSearchByTypeAndTitleGet /api/v1/config/byTypeAndTitle
ConfigurationApiUpdateConfigurationPut /api/v1/config/{configurationId}
ConfigurationApiUpdateGlobalVariablePut /api/v1/config/{variableId}
ConfigurationApiUpdateSystemMessagePut /api/v1/config/system-message
DeliveryApiCompleteStagePost /api/v1/deliveries/{stageId}/complete
DeliveryApiCompleteTrackedItemPut /api/v1/deliveries/{stageId}/{itemId}/complete
DeliveryApiCompleteTransitionPost /api/v1/deliveries/{transitionId}/complete
DeliveryApiCreateTrackedItemInDeliveryPost /api/v1/deliveries/{deliveryId}/tracked-items
DeliveryApiDeleteDeliveryDelete /api/v1/deliveries/{deliveryId}
DeliveryApiDeleteTrackedItemDeliveryDelete /api/v1/deliveries/{itemId}
DeliveryApiDescopeTrackedItemPut /api/v1/deliveries/{itemId}/descope
DeliveryApiGetDeliveryGet /api/v1/deliveries/{deliveryId}
DeliveryApiGetDeliveryTimelineGet /api/v1/deliveries/{deliveryId}/timeline
DeliveryApiGetReleasesForDeliveryGet /api/v1/deliveries/{deliveryId}/releases
DeliveryApiGetStagesInDeliveryGet /api/v1/deliveries/{deliveryId}/stages
DeliveryApiGetTrackedItemsinDeliveryGet /api/v1/deliveries/{deliveryId}/tracked-items
DeliveryApiReopenStagePost /api/v1/deliveries/{stageId}/reopen
DeliveryApiRescopeTrackedItemPut /api/v1/deliveries/{itemId}/rescope
DeliveryApiResetTrackedItemPut /api/v1/deliveries/{stageId}/{itemId}/reset
DeliveryApiSearchDeliveriesPost /api/v1/deliveries/search
DeliveryApiSkipTrackedItemPut /api/v1/deliveries/{stageId}/{itemId}/skip
DeliveryApiUpdateDeliveryPut /api/v1/deliveries/{deliveryId}
DeliveryApiUpdateStageInDeliveryPut /api/v1/deliveries/{stageId}
DeliveryApiUpdateTrackedItemInDeliveryPut /api/v1/deliveries/{itemId}
DeliveryApiUpdateTransitionInDeliveryPut /api/v1/deliveries/{transitionId}
DeliveryPatternApiCheckTitlePost /api/v1/delivery-patterns/checkTitle
DeliveryPatternApiCreateDeliveryFromPatternPost /api/v1/delivery-patterns/{patternId}/create
DeliveryPatternApiCreatePatternPost /api/v1/delivery-patterns
DeliveryPatternApiCreateStagePost /api/v1/delivery-patterns/{patternId}/createStage
DeliveryPatternApiCreateStage1Post /api/v1/delivery-patterns/{patternId}/stages
DeliveryPatternApiCreateStage2Post /api/v1/delivery-patterns/{patternId}/stages/{position}
DeliveryPatternApiCreateTrackedItemInPatternPost /api/v1/delivery-patterns/{patternId}/tracked-items
DeliveryPatternApiCreateTransitionPost /api/v1/delivery-patterns/{stageId}/transitions
DeliveryPatternApiDeletePatternDelete /api/v1/delivery-patterns/{patternId}
DeliveryPatternApiDeleteStageDelete /api/v1/delivery-patterns/{stageId}
DeliveryPatternApiDeleteTrackedItemDeliveryPatternDelete /api/v1/delivery-patterns/{itemId}
DeliveryPatternApiDeleteTransitionDelete /api/v1/delivery-patterns/{transitionId}
DeliveryPatternApiDuplicatePatternPost /api/v1/delivery-patterns/{patternId}/duplicate
DeliveryPatternApiGetPatternGet /api/v1/delivery-patterns/{patternId}
DeliveryPatternApiGetPatternByIdOrTitleGet /api/v1/delivery-patterns/{patternIdOrTitle}
DeliveryPatternApiGetStagesInPatternGet /api/v1/delivery-patterns/{patternId}/stages
DeliveryPatternApiGetTrackedItemsInPatternGet /api/v1/delivery-patterns/{patternId}/tracked-items
DeliveryPatternApiSearchPatternsPost /api/v1/delivery-patterns/search
DeliveryPatternApiUpdatePatternPut /api/v1/delivery-patterns/{patternId}
DeliveryPatternApiUpdateStageFromBatchPut /api/v1/delivery-patterns/{stageId}/batched
DeliveryPatternApiUpdateStageInPatternPut /api/v1/delivery-patterns/{stageId}
DeliveryPatternApiUpdateTrackedItemInPatternPut /api/v1/delivery-patterns/{itemId}
DeliveryPatternApiUpdateTransitionInPatternPut /api/v1/delivery-patterns/{transitionId}
DslApiExportTemplateToXFileGet /api/v1/dsl/export/{templateId}
DslApiPreviewExportTemplateToXFileGet /api/v1/dsl/preview/{templateId}
EnvironmentApiCreateEnvironmentPost /api/v1/environments
EnvironmentApiDeleteEnvironmentDelete /api/v1/environments/{environmentId}
EnvironmentApiGetDeployableApplicationsForEnvironmentGet /api/v1/environments/{environmentId}/applications
EnvironmentApiGetEnvironmentGet /api/v1/environments/{environmentId}
EnvironmentApiGetReservationsForEnvironmentGet /api/v1/environments/{environmentId}/reservations
EnvironmentApiSearchEnvironmentsPost /api/v1/environments/search
EnvironmentApiUpdateEnvironmentPut /api/v1/environments/{environmentId}
EnvironmentLabelApiCreateLabelPost /api/v1/environments/labels
EnvironmentLabelApiDeleteEnvironmentLabelDelete /api/v1/environments/labels/{environmentLabelId}
EnvironmentLabelApiGetLabelByIdGet /api/v1/environments/labels/{environmentLabelId}
EnvironmentLabelApiSearchLabelsPost /api/v1/environments/labels/search
EnvironmentLabelApiUpdateLabelPut /api/v1/environments/labels/{environmentLabelId}
EnvironmentReservationApiAddApplicationPost /api/v1/environments/reservations/{environmentReservationId}
EnvironmentReservationApiCreateReservationPost /api/v1/environments/reservations
EnvironmentReservationApiDeleteEnvironmentReservationDelete /api/v1/environments/reservations/{environmentReservationId}
EnvironmentReservationApiGetReservationGet /api/v1/environments/reservations/{environmentReservationId}
EnvironmentReservationApiSearchReservationsPost /api/v1/environments/reservations/search
EnvironmentReservationApiUpdateReservationPut /api/v1/environments/reservations/{environmentReservationId}
EnvironmentStageApiCreateStage3Post /api/v1/environments/stages
EnvironmentStageApiDeleteEnvironmentStageDelete /api/v1/environments/stages/{environmentStageId}
EnvironmentStageApiGetStageByIdGet /api/v1/environments/stages/{environmentStageId}
EnvironmentStageApiSearchStagesPost /api/v1/environments/stages/search
EnvironmentStageApiUpdateStageInEnvironmentPut /api/v1/environments/stages/{environmentStageId}
FacetApiCreateFacetPost /api/v1/facets
FacetApiDeleteFacetDelete /api/v1/facets/{facetId}
FacetApiGetFacetGet /api/v1/facets/{facetId}
FacetApiGetFacetTypesGet /api/v1/facets/types
FacetApiSearchFacetsPost /api/v1/facets/search
FacetApiUpdateFacetPut /api/v1/facets/{facetId}
FolderApiAddFolderPost /api/v1/folders/{folderId}
FolderApiCreateFolderVariablePost /api/v1/folders/{folderId}/variables
FolderApiDeleteFolderDelete /api/v1/folders/{folderId}
FolderApiDeleteFolderVariableDelete /api/v1/folders/{folderId}/{variableId}
FolderApiFindGet /api/v1/folders/find
FolderApiGetFolderGet /api/v1/folders/{folderId}
FolderApiGetFolderPermissionsGet /api/v1/folders/permissions
FolderApiGetFolderTeamsGet /api/v1/folders/{folderId}/teams
FolderApiGetFolderTemplatesGet /api/v1/folders/{folderId}/templates
FolderApiGetFolderVariableGet /api/v1/folders/{folderId}/{variableId}
FolderApiIsFolderOwnerGet /api/v1/folders/{folderId}/folderOwner
FolderApiListGet /api/v1/folders/{folderId}/list
FolderApiListRootGet /api/v1/folders/list
FolderApiListVariableValuesGet /api/v1/folders/{folderId}/variableValues
FolderApiListVariablesGet /api/v1/folders/{folderId}/variables
FolderApiMovePost /api/v1/folders/{folderId}/move
FolderApiMoveTemplatePost /api/v1/folders/{folderId}/templates/{templateId}
FolderApiRenameFolderPost /api/v1/folders/{folderId}/rename
FolderApiSearchReleasesFolderPost /api/v1/folders/{folderId}/releases
FolderApiSetFolderTeamsPost /api/v1/folders/{folderId}/teams
FolderApiUpdateFolderVariablePut /api/v1/folders/{folderId}/{variableId}
PermissionsApiGetGlobalPermissionsGet /api/v1/global-permissions
PhaseApiAddPhasePost /api/v1/phases/{releaseId}/phase
PhaseApiAddTaskToContainerPost /api/v1/phases/{containerId}/tasks
PhaseApiCopyPhasePost /api/v1/phases/{phaseId}/copy
PhaseApiDeletePhaseDelete /api/v1/phases/{phaseId}
PhaseApiGetPhaseGet /api/v1/phases/{phaseId}
PhaseApiSearchPhasesGet /api/v1/phases/search
PhaseApiSearchPhasesByTitleGet /api/v1/phases/byTitle
PhaseApiUpdatePhasePut /api/v1/phases/{phaseId}
PlannerApiGetActiveReleasesGet /api/v1/analytics/planner/active
PlannerApiGetCompletedReleasesGet /api/v1/analytics/planner/completed
PlannerApiGetReleasesByIdsPost /api/v1/analytics/planner/byIds
ReleaseApiAbortPost /api/v1/releases/{releaseId}/abort
ReleaseApiCountReleasesPost /api/v1/releases/count
ReleaseApiCreateReleaseVariablePost /api/v1/releases/{releaseId}/variables
ReleaseApiDeleteReleaseDelete /api/v1/releases/{releaseId}
ReleaseApiDeleteReleaseVariableDelete /api/v1/releases/{variableId}
ReleaseApiDownloadAttachmentGet /api/v1/releases/attachments/{attachmentId}
ReleaseApiFullSearchReleasesPost /api/v1/releases/fullSearch
ReleaseApiGetActiveTasksGet /api/v1/releases/{releaseId}/active-tasks
ReleaseApiGetArchivedReleaseGet /api/v1/releases/archived/{releaseId}
ReleaseApiGetPossibleReleaseVariableValuesGet /api/v1/releases/{variableId}/possibleValues
ReleaseApiGetReleaseGet /api/v1/releases/{releaseId}
ReleaseApiGetReleasePermissionsGet /api/v1/releases/permissions
ReleaseApiGetReleaseTeamsGet /api/v1/releases/{releaseId}/teams
ReleaseApiGetReleaseVariableGet /api/v1/releases/{variableId}
ReleaseApiGetReleaseVariablesGet /api/v1/releases/{releaseId}/variables
ReleaseApiGetReleasesGet /api/v1/releases
ReleaseApiGetVariableValuesGet /api/v1/releases/{releaseId}/variableValues
ReleaseApiIsVariableUsedReleaseGet /api/v1/releases/{variableId}/used
ReleaseApiReplaceReleaseVariablesPost /api/v1/releases/{variableId}/replace
ReleaseApiRestartPhasesPost /api/v1/releases/{releaseId}/restart
ReleaseApiResumePost /api/v1/releases/{releaseId}/resume
ReleaseApiSearchReleasesByTitleGet /api/v1/releases/byTitle
ReleaseApiSearchReleasesReleasePost /api/v1/releases/search
ReleaseApiSetReleaseTeamsPost /api/v1/releases/{releaseId}/teams
ReleaseApiStartReleasePost /api/v1/releases/{releaseId}/start
ReleaseApiUpdateReleasePut /api/v1/releases/{releaseId}
ReleaseApiUpdateReleaseVariablePut /api/v1/releases/{variableId}
ReleaseApiUpdateReleaseVariablesPut /api/v1/releases/{releaseId}/variables
ReleaseGroupApiAddMembersToGroupPost /api/v1/release-groups/{groupId}/members
ReleaseGroupApiCreateGroupPost /api/v1/release-groups
ReleaseGroupApiDeleteGroupDelete /api/v1/release-groups/{groupId}
ReleaseGroupApiGetGroupGet /api/v1/release-groups/{groupId}
ReleaseGroupApiGetMembersGet /api/v1/release-groups/{groupId}/members
ReleaseGroupApiGetReleaseGroupTimelineGet /api/v1/release-groups/{groupId}/timeline
ReleaseGroupApiRemoveMembersFromGroupDelete /api/v1/release-groups/{groupId}/members
ReleaseGroupApiSearchGroupsPost /api/v1/release-groups/search
ReleaseGroupApiUpdateGroupPut /api/v1/release-groups/{groupId}
ReportApiDownloadReleaseReportGet /api/v1/reports/download/{reportType}/{releaseId}
ReportApiGetRecordsForReleaseGet /api/v1/reports/records/{releaseId}
ReportApiGetRecordsForTaskGet /api/v1/reports/records/{taskId}
ReportApiSearchRecordsPost /api/v1/reports/records/search
RiskApiCopyRiskProfilePost /api/v1/risks/profiles/{riskProfileId}/copy
RiskApiCreateRiskProfilePost /api/v1/risks/profiles
RiskApiDeleteRiskProfileDelete /api/v1/risks/profiles/{riskProfileId}
RiskApiGetAllRiskAssessorsGet /api/v1/risks/assessors
RiskApiGetRiskGet /api/v1/risks/{riskId}
RiskApiGetRiskGlobalThresholdsGet /api/v1/risks/config
RiskApiGetRiskProfileGet /api/v1/risks/profiles/{riskProfileId}
RiskApiGetRiskProfilesGet /api/v1/risks/profiles
RiskApiUpdateRiskGlobalThresholdsPut /api/v1/risks/config
RiskApiUpdateRiskProfilePut /api/v1/risks/profiles/{riskProfileId}
RiskAssessmentApiGetAssessmentGet /api/v1/risks/assessments/{riskAssessmentId}
RolesApiCreateRolesPost /api/v1/roles
RolesApiCreateRoles1Post /api/v1/roles/{roleName}
RolesApiDeleteRolesDelete /api/v1/roles/{roleName}
RolesApiGetRoleGet /api/v1/roles/{roleName}
RolesApiGetRolesGet /api/v1/roles
RolesApiRenameRolesPost /api/v1/roles/{roleName}/rename
RolesApiUpdateRolesPut /api/v1/roles
RolesApiUpdateRoles1Put /api/v1/roles/{roleName}
TaskApiAbortTaskPost /api/v1/tasks/{taskId}/abort
TaskApiAddAttachmentsPost /api/v1/tasks/{taskId}/attachments
TaskApiAddConditionPost /api/v1/tasks/{taskId}/conditions
TaskApiAddDependencyPost /api/v1/tasks/{taskId}/dependencies/{targetId}
TaskApiAddTaskTaskPost /api/v1/tasks/{containerId}/tasks
TaskApiAssignTaskPost /api/v1/tasks/{taskId}/assign/{username}
TaskApiChangeTaskTypePost /api/v1/tasks/{taskId}/changeType
TaskApiCommentTaskPost /api/v1/tasks/{taskId}/comment
TaskApiCompleteTaskPost /api/v1/tasks/{taskId}/complete
TaskApiCopyTaskPost /api/v1/tasks/{taskId}/copy
TaskApiDeleteAttachmentDelete /api/v1/tasks/{taskId}/attachments/{attachmentId}
TaskApiDeleteConditionDelete /api/v1/tasks/{conditionId}
TaskApiDeleteDependencyDelete /api/v1/tasks/{dependencyId}
TaskApiDeleteTaskDelete /api/v1/tasks/{taskId}
TaskApiFailTaskPost /api/v1/tasks/{taskId}/fail
TaskApiGetTaskGet /api/v1/tasks/{taskId}
TaskApiGetTaskVariablesGet /api/v1/tasks/{taskId}/variables
TaskApiLockTaskPut /api/v1/tasks/{taskId}/lock
TaskApiReopenTaskPost /api/v1/tasks/{taskId}/reopen
TaskApiRetryTaskPost /api/v1/tasks/{taskId}/retry
TaskApiSearchTasksByTitleGet /api/v1/tasks/byTitle
TaskApiSkipTaskPost /api/v1/tasks/{taskId}/skip
TaskApiStartTaskPost /api/v1/tasks/{taskId}/start
TaskApiStartTask1Post /api/v1/tasks/{taskId}/startNow
TaskApiUnlockTaskDelete /api/v1/tasks/{taskId}/lock
TaskApiUpdateConditionPost /api/v1/tasks/{conditionId}
TaskApiUpdateInputVariablesPut /api/v1/tasks/{taskId}/variables
TaskApiUpdateTaskPut /api/v1/tasks/{taskId}
TemplateApiCopyTemplatePost /api/v1/templates/{templateId}/copy
TemplateApiCreateTemplatePost /api/v1/templates
TemplateApiCreateTemplate1Post /api/v1/templates/{templateId}/create
TemplateApiCreateTemplateVariablePost /api/v1/templates/{templateId}/variables
TemplateApiDeleteTemplateDelete /api/v1/templates/{templateId}
TemplateApiDeleteTemplateVariableDelete /api/v1/templates/{variableId}
TemplateApiExportTemplateToZipGet /api/v1/templates/zip/{templateId}
TemplateApiGetPossibleTemplateVariableValuesGet /api/v1/templates/{variableId}/possibleValues
TemplateApiGetTemplateGet /api/v1/templates/{templateId}
TemplateApiGetTemplatePermissionsGet /api/v1/templates/permissions
TemplateApiGetTemplateTeamsGet /api/v1/templates/{templateId}/teams
TemplateApiGetTemplateVariableGet /api/v1/templates/{variableId}
TemplateApiGetTemplateVariablesGet /api/v1/templates/{templateId}/variables
TemplateApiGetTemplatesGet /api/v1/templates
TemplateApiImportTemplatePost /api/v1/templates/import
TemplateApiIsVariableUsedTemplateGet /api/v1/templates/{variableId}/used
TemplateApiReplaceTemplateVariablesPost /api/v1/templates/{variableId}/replace
TemplateApiSetTemplateTeamsPost /api/v1/templates/{templateId}/teams
TemplateApiStartTemplatePost /api/v1/templates/{templateId}/start
TemplateApiUpdateTemplatePut /api/v1/templates/{templateId}
TemplateApiUpdateTemplateVariablePut /api/v1/templates/{variableId}
TemplateApiUpdateTemplateVariablesPut /api/v1/templates/{releaseId}/variables
TriggersApiAddTriggerPost /api/v1/triggers
TriggersApiDisableAllTriggersPost /api/v1/triggers/disable/all
TriggersApiDisableTriggerPut /api/v1/triggers/{triggerId}/disable
TriggersApiDisableTriggersPost /api/v1/triggers/disable
TriggersApiEnableAllTriggersPost /api/v1/triggers/enable/all
TriggersApiEnableTriggerPut /api/v1/triggers/{triggerId}/enable
TriggersApiEnableTriggersPost /api/v1/triggers/enable
TriggersApiGetTriggerGet /api/v1/triggers/{triggerId}
TriggersApiGetTypesGet /api/v1/triggers/types
TriggersApiRemoveTriggerDelete /api/v1/triggers/{triggerId}
TriggersApiRunTriggerPost /api/v1/triggers/{triggerId}/run
TriggersApiSearchTriggersGet /api/v1/triggers
TriggersApiUpdateTriggerPut /api/v1/triggers/{triggerId}
UserApiCreateUserPost /api/v1/users/{username}
UserApiDeleteUserRestDelete /api/v1/users/{username}
UserApiFindUsersGet /api/v1/users
UserApiGetUserGet /api/v1/users/{username}
UserApiUpdatePasswordPost /api/v1/users/{username}/password
UserApiUpdateUserPut /api/v1/users/{username}
UserApiUpdateUsersRestPut /api/v1/users

Documentation For Models

Documentation For Authorization

basicAuth

  • 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)

patAuth

  • Type: API key
  • API key parameter name: x-release-personal-token
  • Location: HTTP header

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

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