| GET | /status | Verify that the service runs correctly. | The reply itself is a verification of success, and causes a warmup, furthermore contact with database and other required services is checked. |
|---|
"use strict";
export class StatusResponse {
/** @param {{databaseConnectionOk?:boolean,searchConnectionOk?:boolean,deployedVersion?:string,deployedAt?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?boolean} */
databaseConnectionOk;
/** @type {?boolean} */
searchConnectionOk;
/** @type {string} */
deployedVersion;
/** @type {?string} */
deployedAt;
}
export class StatusRequest {
constructor(init) { Object.assign(this, init) }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /status HTTP/1.1 Host: unstable-consumer-api.brovs.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
databaseConnectionOk: False,
searchConnectionOk: False,
deployedVersion: String,
deployedAt: 0001-01-01T00:00:00.0000000+00:00
}