# README
Titan Go Client
This project publishes a go client for Titan Server. It is entirely autogenerated from the OpenAPI specification. Do not edit files directly, see the Developing section for more info.
Contributing
This project follows the Titan community best practices:
It is maintained by the Titan community maintainers
For more information on how it works, and how to build and release new versions, see the Development Guidelines.
License
This is code is licensed under the Apache License 2.0. Full license is available here.
# 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 Titan API API v0.3.0 In most cases there should be only one, shared, APIClient.
ApiError struct for ApiError.
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.
Commit struct for Commit.
CommitStatus struct for CommitStatus.
Configuration stores the configuration of the API client.
Context struct for Context.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetOperationProgressOpts Optional parameters for the method 'GetOperationProgress'.
ListCommitsOpts Optional parameters for the method 'ListCommits'.
ListOperationsOpts Optional parameters for the method 'ListOperations'.
ListRemoteCommitsOpts Optional parameters for the method 'ListRemoteCommits'.
Operation struct for Operation.
ProgressEntry struct for ProgressEntry.
PullOpts Optional parameters for the method 'Pull'.
PushOpts Optional parameters for the method 'Push'.
Remote struct for Remote.
RemoteParameters struct for RemoteParameters.
Repository struct for Repository.
RepositoryStatus struct for RepositoryStatus.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Volume struct for Volume.
VolumeStatus struct for VolumeStatus.
# Type aliases
CommitsApiService CommitsApi service.
ContextsApiService ContextsApi service.
OperationsApiService OperationsApi service.
RemotesApiService RemotesApi service.
RepositoriesApiService RepositoriesApi service.
VolumesApiService VolumesApi service.