Categorygithub.com/TheCacophonyProject/go-api
modulepackage
1.2.3
Repository: https://github.com/thecacophonyproject/go-api.git
Documentation: pkg.go.dev

# README

go-api

Client for the Cacophony API server.

Test Setup

To run the tests you need to setup a cacophony-api instance and add some entries to the SQL DB

  • Follow setup the instructions at Cacophony API server
  • Copy SQL file to API docker container sudo docker cp db-test-seed.sql cacophony-api:/db-seed.sql
  • Run SQL file sudo docker exec cacophony-api sh -c "sudo -i -u postgres psql cacophonytest -f/db-seed.sql"

# Functions

No description provided by the author
IsPermanentError examines the supplied error and returns true if it is permanent.
New will get an API from the config files and authenticate.
No description provided by the author
Register will check that there is not already device config files, will then register with the given parameters and then save them in new config files.

# Variables

No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Error is returned by API calling methods.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ensure names match the API.
No description provided by the author