libcapsul/gomarkdoc.md

59 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2021-10-20 15:13:26 +00:00
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
# libcapsul
```go
import "coopcloud.tech/libcapsul"
```
2021-10-22 07:48:48 +00:00
Package libcapsul provides Capsul operations functionality\.
2021-10-20 15:13:26 +00:00
## Index
- [type CapsulClient](<#type-capsulclient>)
- [func New(instanceURL, APIToken string) CapsulClient](<#func-new>)
2021-10-22 07:48:48 +00:00
- [func (c CapsulClient) Create(capsulName, capsulType, capsulImage string, capsulSSHKeys []string) (CapsulCreateResponse, error)](<#func-capsulclient-create>)
2021-10-20 15:13:26 +00:00
- [type CapsulCreateResponse](<#type-capsulcreateresponse>)
## type CapsulClient
CapsulClient is a Capsul client interface\.
```go
type CapsulClient struct {
InstanceURL string
APIToken string
}
```
### func New
```go
func New(instanceURL, APIToken string) CapsulClient
```
New creates a new Capsul client\.
### func \(CapsulClient\) Create
```go
2021-10-22 07:48:48 +00:00
func (c CapsulClient) Create(capsulName, capsulType, capsulImage string, capsulSSHKeys []string) (CapsulCreateResponse, error)
2021-10-20 15:13:26 +00:00
```
Create creates a new capsul\.
## type CapsulCreateResponse
CapsulCreateResponse is a Capsul creation response payload\.
```go
type CapsulCreateResponse struct {
ID string
}
```
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)