Go API client for openapi

The API for the Hoarder app

API documentation

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.10.0-SNAPSHOT
• 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/flowline-io/sdk-hoarder-api"

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 openapi.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 openapi.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 openapi.ContextOperationServerIndices and openapi.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 https://try.hoarder.app/api/v1

Class	Method	HTTP request	Description
BookmarksAPI	BookmarksBookmarkIdDelete	Delete /bookmarks/{bookmarkId}	Delete a bookmark
BookmarksAPI	BookmarksBookmarkIdGet	Get /bookmarks/{bookmarkId}	Get a single bookmark
BookmarksAPI	BookmarksBookmarkIdPatch	Patch /bookmarks/{bookmarkId}	Update a bookmark
BookmarksAPI	BookmarksBookmarkIdTagsDelete	Delete /bookmarks/{bookmarkId}/tags	Detach tags from a bookmark
BookmarksAPI	BookmarksBookmarkIdTagsPost	Post /bookmarks/{bookmarkId}/tags	Attach tags to a bookmark
BookmarksAPI	BookmarksGet	Get /bookmarks	Get all bookmarks
BookmarksAPI	BookmarksPost	Post /bookmarks	Create a new bookmark
ListsAPI	ListListIdPatch	Patch /list/{listId}	Update a list
ListsAPI	ListsGet	Get /lists	Get all lists
ListsAPI	ListsListIdBookmarksBookmarkIdDelete	Delete /lists/{listId}/bookmarks/{bookmarkId}	Remove a bookmark from a list
ListsAPI	ListsListIdBookmarksBookmarkIdPut	Put /lists/{listId}/bookmarks/{bookmarkId}	Add a bookmark to a list
ListsAPI	ListsListIdBookmarksGet	Get /lists/{listId}/bookmarks	Get a bookmarks in a list
ListsAPI	ListsListIdDelete	Delete /lists/{listId}	Delete a list
ListsAPI	ListsListIdGet	Get /lists/{listId}	Get a single list
ListsAPI	ListsPost	Post /lists	Create a new list
TagsAPI	TagsGet	Get /tags	Get all tags
TagsAPI	TagsTagIdBookmarksGet	Get /tags/{tagId}/bookmarks	Get a bookmarks with the tag
TagsAPI	TagsTagIdDelete	Delete /tags/{tagId}	Delete a tag
TagsAPI	TagsTagIdGet	Get /tags/{tagId}	Get a single tag
TagsAPI	TagsTagIdPatch	Patch /tags/{tagId}	Update a tag

Documentation For Models

• Bookmark
• BookmarkAssetsInner
• BookmarkContent
• BookmarkContentOneOf
• BookmarkContentOneOf1
• BookmarkContentOneOf2
• BookmarkContentOneOf3
• BookmarkTagsInner
• BookmarksBookmarkIdPatch200Response
• BookmarksBookmarkIdPatchRequest
• BookmarksBookmarkIdTagsDelete200Response
• BookmarksBookmarkIdTagsPost200Response
• BookmarksBookmarkIdTagsPostRequest
• BookmarksBookmarkIdTagsPostRequestTagsInner
• BookmarksPostRequest
• BookmarksPostRequestAllOfOneOf
• BookmarksPostRequestAllOfOneOf1
• BookmarksPostRequestAllOfOneOf2
• List
• ListListIdPatchRequest
• ListsGet200Response
• ListsPostRequest
• PaginatedBookmarks
• Tag
• TagNumBookmarksByAttachedType
• TagsGet200Response
• TagsTagIdPatchRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "BEARER_TOKEN_STRING")
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