cloudnative-pg / cloudnative-pg/plugin-barman-cloud
incomplete API Reference
- Dominant language
- Go
- Stars
- 191
- Forks
- 72
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 21
Description
[The API reference for `ObjectStoreSpec`](https://cloudnative-pg.io/plugin-barman-cloud/docs/plugin-barman-cloud.v1/#objectstorespec) as of v0.9.0 describes the rather important `configuration` field, but instead of referencing a clear description for that field references to the matching [some Go struct](https://pkg.go.dev/github.com/cloudnative-pg/barman-cloud/pkg/api#BarmanObjectStoreConfiguration), which is much harder to read - especially for people not familiar with Go.
Since this is a required part of the configuration, I guess it would be very helpful to have a clear description for this field, like the rest of the API reference.
Contributor guide
Assessment
This issue has not been assessed yet.