rpi-relay/spec.json

{"consumes":["application/json"],"produces":["application/json"],"schemes":["http","https"],"swagger":"2.0","info":{"title":"RPI Relay API.","termsOfService":"there are no TOS at this moment, use at your own risk we take no responsibility","version":"0.0.1"},"host":"localhost","basePath":"/","paths":{"/api/relay":{"get":{"security":[{"api_key":[]}],"description":"get relay state","tags":["relay"],"operationId":"getState","responses":{"200":{"$ref":"#/responses/relayStateResp"},"default":{"$ref":"#/responses/respDefault"}}}},"/api/relay/off":{"post":{"security":[{"api_key":[]}],"description":"set relay off","tags":["relay"],"operationId":"switchOff","responses":{"default":{"$ref":"#/responses/respDefault"}}}},"/api/relay/on":{"post":{"security":[{"api_key":[]}],"description":"set relay on","tags":["relay"],"operationId":"switchOn","responses":{"default":{"$ref":"#/responses/respDefault"}}}}},"definitions":{"MessageCode":{"type":"integer","format":"int64","x-go-package":"rpirelay/internal/response"},"RespBody":{"type":"object","properties":{"message":{"type":"string","x-go-name":"Message"},"messageCode":{"$ref":"#/definitions/MessageCode"}},"x-go-package":"rpirelay/internal/response"},"relayStateResp":{"type":"object","properties":{"open":{"type":"boolean","x-go-name":"Open"}},"x-go-package":"rpirelay/internal/api/relay/transport"}},"responses":{"relayStateResp":{"description":"","schema":{"$ref":"#/definitions/relayStateResp"}},"respDefault":{"description":"default response","schema":{"$ref":"#/definitions/RespBody"},"headers":{"Status":{"type":"integer","format":"int64"}}}},"securityDefinitions":{"api_key":{"description":"secret","type":"apiKey","name":"X-Lawsnote-Key","in":"header"}}}