Categorygithub.com/grokify/go-aha/v2aha
package
2.5.2
Repository: https://github.com/grokify/go-aha.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
23
Dependents
11
Files
1.6k SLOC

# README

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

Installation

Install the following dependencies:

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

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

import "./aha"

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
FeaturesApiGetFeatureGet /features/{feature_id}
FeaturesApiGetFeaturesGet /featuresGet all features
FeaturesApiGetReleaseFeaturesGet /releases/{release_id}/featuresGet all features for a release
FeaturesApiUpdateFeaturePut /features/{feature_id}Update a feature's custom fields with tag-like value
ProductsApiGetProductGet /products/{product_id}Products API
ProductsApiGetProductsGet /productsProducts API
ReleasesApiGetProductReleasesGet /products/{product_id}/releases
ReleasesApiGetReleaseGet /releases/{release_id}
ReleasesApiUpdateProductReleasePut /products/{product_id}/releases/{release_id}Update a release

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the Aha.io API API v1.0.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
CustomField struct for CustomField.
Feature struct for Feature.
FeatureMeta struct for FeatureMeta.
FeaturesResponse struct for FeaturesResponse.
FeatureUpdate struct for FeatureUpdate.
FeatureWorkflowStatus struct for FeatureWorkflowStatus.
FeatureWrap struct for FeatureWrap.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetFeaturesOpts Optional parameters for the method 'GetFeatures'.
GetProductReleasesOpts Optional parameters for the method 'GetProductReleases'.
GetProductsOpts Optional parameters for the method 'GetProducts'.
GetReleaseFeaturesOpts Optional parameters for the method 'GetReleaseFeatures'.
Pagination struct for Pagination.
Product struct for Product.
ProductMeta struct for ProductMeta.
ProductResponse struct for ProductResponse.
ProductsResponse struct for ProductsResponse.
Release struct for Release.
ReleasesResponse struct for ReleasesResponse.
ReleaseUpdate struct for ReleaseUpdate.
ReleaseUpdateWrap struct for ReleaseUpdateWrap.
ReleaseWrap struct for ReleaseWrap.
User struct for User.

# Type aliases

FeaturesApiService FeaturesApi service.
ProductsApiService ProductsApi service.
ReleasesApiService ReleasesApi service.