github/go-unifi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add detailed usage documentation together with examples (#29)

Browse Source 
* feat: rename Pass to Password in ClientConfig

* docs: add more detailed usage documentation together with examples

* chore: update issue templates

* docs: add codeowners, code of conduct and contributing docs

* chore: add editorconfig

* chore: apply linter
This commit is contained in:
Mateusz Filipowicz
2025-02-18 22:36:08 +01:00
committed by GitHub
parent 5b32a4763e
commit 35e7b2c3cc
16 changed files with 1177 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,4 +1,5 @@
# UniFi Go SDK
[![Docs](https://img.shields.io/badge/docs-reference-blue)](https://pkg.go.dev/github.com/filipowm/go-unifi)
[![GoDoc](https://godoc.org/github.com/filipowm/go-unifi?status.svg)](https://godoc.org/github.com/filipowm/go-unifi)
![GitHub Release](https://img.shields.io/github/v/release/filipowm/go-unifi)
![GitHub branch check runs](https://img.shields.io/github/check-runs/filipowm/go-unifi/main)
@@ -10,12 +11,18 @@ but can be used independently for any Go project requiring UniFi Network Control
## Features
- Great UniFi Network Controller API coverage through automated code generation and manually added code for undocumented endpoints
- Easy to use client with support for API Key and username/password authentication
- Generated data models from UniFi Controller API specifications
- Daily automated updates to track the latest UniFi Controller versions
- Easy to use client with support for API Key and username/password authentication
- Support for multiple UniFi Controller versions
- Strong typing for all API models with Go structs
## Supported UniFi Controller Versions
Any version after 5.12.35 is supported as of now. **Latest version: 9.0.114**.
The SDK is updated daily to track the latest UniFi Controller versions.
If you encounter any issues with the latest UniFi Controller version, please open an issue.
## Code Generation
The data models and basic REST methods are generated from JSON specifications found in the UniFi Controller JAR files. Those JSON specs show all fields and the associated regex/validation information.
@@ -176,15 +183,15 @@ user, err := c.CreateUser(ctx, "site-name", &unifi.User{
## Plans
- [ ] Increase API coverage, or modify code generation to rely on the official UniFi Controller API specifications
- [x] Increase API coverage, or modify code generation to rely on the official UniFi Controller API specifications
- [x] Improve error handling (currently only basic error handling is implemented and error details are not propagated)
- [x] Improve client code for better usability
- [x] Support API Key authentication
- [ ] Generate client code for currently generated API structures, for use within or outside the Terraform provider
- [x] Generate client code for currently generated API structures, for use within or outside the Terraform provider
- [ ] Increase test coverage
- [x] Implement validation for fields and structures
- [ ] Extend validators for more complex cases
- [ ] Add more documentation and examples
- [x] Add more documentation and examples
- [ ] Bugfixing...
## Contributing