Go API client for openapi

Welcome to your ArchiveBox server's REST API [v1 ALPHA] homepage!

WARNING: This API is still in an early development stage and may change!

• ⬅️ Manage your server: Setup API Keys, Go to your Server Admin UI, Go to your Snapshots list
• 💬 Ask questions and get help here: ArchiveBox Chat Forum
• 🐞 Report API bugs here: Github Issues
• 📚 ArchiveBox Documentation: Github Wiki
• 📜 See the API source code: archivebox/api/

Served by ArchiveBox v0.8.5rc50 (1dff8bae), API powered by django-ninja.

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/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 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 http://localhost

Class	Method	HTTP request	Description
ArchiveBoxCLISubCommandsAPI	ApiV1CliCliAdd	Post /api/v1/cli/add	archivebox add [args] [urls]
ArchiveBoxCLISubCommandsAPI	ApiV1CliCliList	Post /api/v1/cli/list	archivebox list [args] [filter_patterns]
ArchiveBoxCLISubCommandsAPI	ApiV1CliCliRemove	Post /api/v1/cli/remove	archivebox remove [args] [filter_patterns]
ArchiveBoxCLISubCommandsAPI	ApiV1CliCliSchedule	Post /api/v1/cli/schedule	archivebox schedule [args] [import_path]
ArchiveBoxCLISubCommandsAPI	ApiV1CliCliUpdate	Post /api/v1/cli/update	archivebox update [args] [filter_patterns]
AuthenticationAPI	ApiV1AuthCheckApiToken	Post /api/v1/auth/check_api_token	Validate an API token to make sure its valid and non-expired
AuthenticationAPI	ApiV1AuthGetApiToken	Post /api/v1/auth/get_api_token	Generate an API token for a given username & password (or currently logged-in user)
CoreModelsAPI	ApiV1CoreGetAny	Get /api/v1/core/any/{abid}	Get Any
CoreModelsAPI	ApiV1CoreGetArchiveresult	Get /api/v1/core/archiveresult/{archiveresult_id}	Get Archiveresult
CoreModelsAPI	ApiV1CoreGetArchiveresults	Get /api/v1/core/archiveresults	Get Archiveresults
CoreModelsAPI	ApiV1CoreGetSnapshot	Get /api/v1/core/snapshot/{snapshot_id}	Get Snapshot
CoreModelsAPI	ApiV1CoreGetSnapshots	Get /api/v1/core/snapshots	Get Snapshots
CoreModelsAPI	ApiV1CoreGetTag	Get /api/v1/core/tag/{tag_id}	Get Tag
CoreModelsAPI	ApiV1CoreGetTags	Get /api/v1/core/tags	Get Tags

Documentation For Models

• AddCommandSchema
• ArchiveResultFilterSchema
• ArchiveResultSchema
• AsCsv
• CLICommandResponseSchema
• Input
• ListCommandSchema
• MinimalArchiveResultSchema
• PagedArchiveResultSchema
• PagedSnapshotSchema
• PagedTagSchema
• PasswordAuthSchema
• RemoveCommandSchema
• Response
• Result
• ScheduleCommandSchema
• SnapshotFilterSchema
• SnapshotSchema
• StatusChoices
• TagSchema
• TokenAuthSchema
• UpdateCommandSchema

Documentation For Authorization

Authentication schemes defined for the API:

HeaderTokenAuth

• Type: API key
• API key parameter name: X-ArchiveBox-API-Key
• Location: HTTP header

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

Example

auth := context.WithValue(
		context.Background(),
		openapi.ContextAPIKeys,
		map[string]openapi.APIKey{
			"HeaderTokenAuth": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

BearerTokenAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

QueryParamTokenAuth

• Type: API key
• API key parameter name: api_key
• Location: URL query string

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

Example

auth := context.WithValue(
		context.Background(),
		openapi.ContextAPIKeys,
		map[string]openapi.APIKey{
			"QueryParamTokenAuth": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

UsernameAndPasswordAuth

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), openapi.ContextBasicAuth, openapi.BasicAuth{
	UserName: "username",
	Password: "password",
})
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