danclegg / av-api

BYU's campus-wide, RESTful, HATEOAS-compliant, audiovisual API

av-api

Setup

CONFIGURATION_DATABASE_MICROSERVICE_ADDRESS needs to be set to enable communication with the configuration-database-microservice. The EMS_API_USERNAME and EMS_API_PASSWORD environment variables need to be set in order to retrieve room availability data from the Event Management System.

Example Usage

Perform a PUT on http://localhost:8000/buildings/ITB/rooms/1001D with the following body:

{
	"currentVideoInput": "AppleTV",
	"displays": [{
		"name": "D1",
		"power": "on",
		"blanked": false
	}],
	"audioDevices": [{
		"volume": 10
	}]
}

Docker Development

For Docker development via docker-compose utilize the following commands depending on your use case:

Development Testing (Build Containers Locally)

docker-compose -f docker-compose-dev.yml up

Production Testing (Pull Containers)

docker-compose -f docker-compose-prod.yml up