Overview • Gateway-Route • Discovery-Route • FestivalsAPI-Route • Database-Route • FestivalsFilesAPI-Route
- Documentation:
Markdown
,HTML
- Server Application:
golang
- Deployment:
bash
To access the gateway you need to either provide a service key via a custom header or a JWT with your requests authorization header, requests to the loadbalanced services don't need any means of authentication:
Service-Key:<service-key>
Authorization: Bearer <jwt>
- GET
/info
- GET
/version
- POST
/update
- GET
/health
- GET
/log
- GET
/log/trace
- POST
/loversear
- GET
/services
- GET, POST, PATCH, DELETE
/*
- GET, POST, PATCH, DELETE
/*
- GET, POST, PATCH, DELETE
/*
The gateway route listens on requests to 'https://gateway.hostname'.
Determine the state of the server.
Info object
{
"BuildTime": string,
"GitRef": string,
"Version": string
}
-
Authorization: JWT
-
Example:
GET https://gateway.festivalsapp.dev/info
-
Returns
- Returns the info object
- Codes
200
/40x
/50x
data
orerror
field
-
Authorization: JWT
-
Example:
GET https://gateway.festivalsapp.dev/version
-
Returns
- The version of the server application.
- Codes
200
/40x
/50x
- server version as a string
text/plain
Updates to the newest release on github and restarts the service.
-
Authorization: JWT
-
Example:
POST https://gateway.festivalsapp.dev/update
-
Returns
- The version of the server application.
- Codes
202
/40x
/50x
- server version as a string
text/plain
-
Authorization: JWT
-
Example:
GET https://gateway.festivalsapp.dev/health
-
Returns
- Always returns HTTP status code 200
- Code
200
- empty
text/plain
Returns the service log.
-
Authorization: JWT
-
Example:
GET https://gateway.festivalsapp.dev/log
-
Returns
- Returns a string
- Codes
200
/40x
/50x
- empty or
text/plain
Returns the service trace log.
-
Authorization: JWT
-
Example:
GET https://gateway.festivalsapp.dev/log/trace
-
Returns
- Returns a string
- Codes
200
/40x
/50x
- empty or
text/plain
The discovery route listens on requests to 'https://discovery.hostname'.
-
Authorization: Service key
-
Example:
POST https://discovery.festivalsapp.dev/loversear
-
Returns
- Returns nothing on success but a 202 status code.
- Code
202
/400
- Empty text or
error
field
-
Authorization: Service key
-
Example:
GET https://discovery.festivalsapp.dev/services
-
Returns
- Returns the currently available
MonitorNode
s. - Code
202
/40x
data
orerror
field
- Returns the currently available
The FestivalsAPI route loadbalances and proxys requests from 'https://api.hostname' to the apropriate services.
The database route loadbalances and proxys requests from 'https://database.hostname' to the apropriate services.
The FestivalsFilesAPI route loadbalances and proxys requests from 'https://files.hostname' to the apropriate services.