package
6.0.0-beta.10+incompatible
Repository: https://github.com/nuts-foundation/nuts-node.git
Documentation: pkg.go.dev

# Functions

NewAPIClient create a new API Client to communicate with a remote storage server.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewDeleteSecretRequest generates requests for DeleteSecret.
NewHealthCheckRequest generates requests for HealthCheck.
NewListKeysRequest generates requests for ListKeys.
NewLookupSecretRequest generates requests for LookupSecret.
NewStoreSecretRequest calls the generic StoreSecret builder with application/json body.
NewStoreSecretRequestWithBody generates requests for StoreSecret with any type of body.
ParseDeleteSecretResponse parses an HTTP response from a DeleteSecretWithResponse call.
ParseHealthCheckResponse parses an HTTP response from a HealthCheckWithResponse call.
ParseListKeysResponse parses an HTTP response from a ListKeysWithResponse call.
ParseLookupSecretResponse parses an HTTP response from a LookupSecretWithResponse call.
ParseStoreSecretResponse parses an HTTP response from a StoreSecretWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

Defines values for ServiceStatusStatus.
Defines values for ServiceStatusStatus.
StorageType is the name of this storage type, used in health check reports and configuration.
Defines values for ServiceStatusStatus.

# Structs

APIClient implements the Storage interface.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
Config is the configuration for the APIClient.
No description provided by the author
ErrorResponse The ErrorResponse contains the Problem Details for HTTP APIs as specified in [RFC7807](https://tools.ietf.org/html/rfc7807).
No description provided by the author
No description provided by the author
No description provided by the author
SecretResponse Response object containing the secret value.
ServiceStatus Response for the health check endpoint.
StoreSecretRequest Request body to store a secret value.
No description provided by the author

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.

# Type aliases

ClientOption allows setting custom parameters during construction.
Key The key under which secrets can be stored or retrieved.
KeyList List of keys currently stored in the store.
RequestEditorFn is the function signature for the RequestEditor callback function.
Secret The secret value stored under the provided key.
ServiceStatusStatus Indicates whether the service status is acceptable.
StoreSecretJSONRequestBody defines body for StoreSecret for application/json ContentType.