Skip to content
Snippets Groups Projects
Commit b41d82e0 authored by Sigmund, Dominik's avatar Sigmund, Dominik
Browse files

Add openapi definitions and fix package.main

parent 8727ba0b
Branches
Tags 1.1.0
No related merge requests found
Pipeline #56941 passed
{
"[markdown]": {
"editor.cursorSurroundingLines": 0
}
}
\ No newline at end of file
......@@ -47,3 +47,30 @@ function metaRoutes(app, { version, config, isServiceReady, metricsEndpoint }, r
}
module.exports = metaRoutes;
/**
* GET /_version
* @summary Returns the version of the service
* @tags meta
* @return {string} 200 - The version of the service
*/
/**
* GET /_config
* @summary Returns the configuration of the service with redacted secrets
* @tags meta
* @return {object} 200 - The configuration of the service
*/
/**
* GET /_health
* @summary Returns the health of the service
* @description This endpoint is used to check if the service is healthy and should always return 200
* @tags meta
* @return {string} 200 - OK
*/
/**
* GET /_ready
* @summary Returns the readiness of the service
* @description This endpoint is used to check if the service is ready and should return 200 if the service is ready to serve requests
* @tags meta
* @return {string} 200 - OK
* @return {string} 503 - Service Unavailable
*/
\ No newline at end of file
{
"name": "@libs/metaroutes",
"version": "1.0.0",
"version": "1.1.0",
"description": "Add default metaroutes to express app",
"main": "index.ts",
"main": "index.js",
"scripts": {
"test": "jest",
"test:mutation": "stryker run"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment