Go API client for aha

Articles that matter on social publishing platform

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.0.0
• Package version: 1.0.0
• Generator version: 7.14.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 aha "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 aha.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), aha.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 aha.ContextOperationServerIndices and aha.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
FeaturesAPI	GetFeature	Get /features/{feature_id}	Get feature
FeaturesAPI	GetFeatures	Get /features	Get features
FeaturesAPI	GetReleaseFeatures	Get /releases/{release_id}/features	Get all features for a release
IdeasAPI	GetIdea	Get /ideas/{idea_id}	Get Idea
ProductsAPI	GetProduct	Get /products/{product_id}	Get product
ProductsAPI	GetProducts	Get /products	Get products
ReleasesAPI	GetProductReleases	Get /products/{product_id}/releases	Get product releases
ReleasesAPI	GetRelease	Get /releases/{release_id}	Get release
ReleasesAPI	UpdateProductRelease	Put /products/{product_id}/releases/{release_id}	Update product release

Documentation For Models

• Category
• CustomField
• Feature
• FeatureMeta
• FeatureUpdate
• FeatureWorkflowStatus
• FeatureWrap
• FeaturesResponse
• Idea
• IdeaFeature
• IdeaResponse
• IntegrationField
• Pagination
• Product
• ProductMeta
• ProductResponse
• ProductsResponse
• Release
• ReleaseUpdate
• ReleaseUpdateWrap
• ReleaseWrap
• ReleasesResponse
• User

Documentation For Authorization

Endpoints do not require authorization.

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