# README
go-katapult
Go client library for Katapult.
WARNING: Work in progress; features are missing, there will be breaking changes.
Documentation:
Experimental "next" Client
A more feature complete client is being generated in the next package.
The aim for this client is to be generated from an openapi spec and should
offer access to everything that is documented / exposed in our API documentation.
Usage Guidance
Each endpoint has multiple functions for calling it.
Typically FunctionName and FunctionNameWithResponse are provided.
It is recommended to use the FunctionNameWithResponse functions as they
return a response object that contains the response data and the HTTP response
object.
The FunctionName functions are provided for convenience and return only the
response data.
Example
res, err := client.GetDataCenterDefaultNetworkWithResponse(ctx,
&katapult.GetDataCenterDefaultNetworkParams{
DataCenterPermalink: "perma-link",
},
)