| GET | /test | Simple test method to confirm the services are working |
|---|
"use strict";
export class TestResult {
/** @param {{wasSuccessful?:boolean,description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
wasSuccessful;
/** @type {string} */
description;
}
export class TestResponse {
/** @param {{environment?:string,tests?:{ [index: string]: TestResult; },wasSuccessful?:boolean,db?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
environment;
/** @type {{ [index: string]: TestResult; }} */
tests;
/** @type {boolean} */
wasSuccessful;
/** @type {string} */
db;
}
export class Test {
/** @param {{smtp?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description An email address a test email will be sent to */
smtp;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /test HTTP/1.1 Host: cochraneplus-api-dev.happen.zone Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"environment":"String","tests":{"String":{"wasSuccessful":false,"description":"String"}},"wasSuccessful":false,"db":"String"}