README
¶
go-api-schemas
go-api-schemas is a tool for generating and persisting user configuration option schemas from Aiven APIs. This repository also contains pre-generated and ready-to-use schemas.
Originally this was a part of aiven-go-client.
Features
This tool can be used to generate and persist user configuration option schemas from Aiven APIs.
It also has a smart diffing mechanism that can be used to detect changes in the schemas and reflect them in the generated schemas.
Setup
See CONTRIBUTING.md for instructions on how to set up the development environment.
License
go-api-schemas is licensed under the Apache license, version 2.0. Full license text is available in the LICENSE file.
Please note that the project explicitly does not require a CLA (Contributor License Agreement) from its contributors.
Contact
Bug reports and patches are very welcome, please post them as GitHub issues and pull requests at https://github.com/aiven/go-api-schemas. To report any possible vulnerabilities or other serious issues please see our security policy.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd is the package that contains the commands of the application.
|
Package cmd is the package that contains the commands of the application. |
|
internal
|
|
|
convert
Package convert is the package that contains the convert functionality.
|
Package convert is the package that contains the convert functionality. |
|
diff
Package diff is the package that contains the diff functionality.
|
Package diff is the package that contains the diff functionality. |
|
gen
Package gen is the package that contains the generation logic.
|
Package gen is the package that contains the generation logic. |
|
pkg/types
Package types contains the types of the application.
|
Package types contains the types of the application. |
|
pkg/util
Package util is the package that contains the utility functions.
|
Package util is the package that contains the utility functions. |
|
reader
Package reader is the package that contains the reader functionality.
|
Package reader is the package that contains the reader functionality. |
|
writer
Package writer is the package that contains the writer functionality.
|
Package writer is the package that contains the writer functionality. |
|
pkg
|
|
|
dist
Package dist contains the embedded files.
|
Package dist contains the embedded files. |