Merge pull request #35 from DataSeer/bugfix/ping

Bugfix/ping

Author: NicolasKieffer

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.0.1](https://github.com/DataSeer/snapshot-api/compare/v2.0.0...v2.0.1) (2025-02-13)
+
+
+### Features
+
+* add durations (ms) in HTTP logs, for grafana charts ([5cc660c](https://github.com/DataSeer/snapshot-api/commits/5cc660cd03e0da98e07c25618c3319298091e626))
+
+
+### Bug Fixes
+
+* ping API route (/ping) must return HTTP status 200 even if a service check health status failed ([db53d4d](https://github.com/DataSeer/snapshot-api/commits/db53d4dd21d4ad7a771d2d82cfdfe02f7ed1676f))
+
+
+### Documentation
+
+* update the 'user documentation' (cumulated score) ([46d7868](https://github.com/DataSeer/snapshot-api/commits/46d7868d99e059f08c769c7b1b42c2a5ea4731cb))
+
 ## [2.0.0](https://github.com/DataSeer/snapshot-api/compare/v1.0.0...v2.0.0) (2025-01-15)
 
 

USER_DOCUMENTATION.md

@@ -11,7 +11,7 @@
 
 This document provides detailed information about the available endpoints in
 the [Snapshot API](https://snapshot.dataseer.ai) (hosted on [snapshot.dataseer.ai](https://snapshot.dataseer.ai)).
-The API expects to receive one PDF document for each request, along with, requred parameters and an authentication
+The API expects to receive one PDF document for each request, along with, required parameters and an authentication
 token, and it returns a JSON response with the computed OSI scores and other relevant information.
 
 ## Authentication
@@ -23,8 +23,8 @@ The API tokens must be included in each requests `Authorization header`:
 Authorization: Bearer <your_token>
 ```
 
-Should you need an API token or have issues with authentication, please contact the DataSeer support. Each API token is
-bounded to a specific user and API throughput limits of 100 request each 15 minutes.
+Should you need an API token or have issues with authentication, please contact DataSeer support ([email protected]). Each API token is
+bounded to a specific user.
 
 ## API Endpoints
 
@@ -236,5 +236,5 @@ The API uses standard HTTP status codes to indicate the success or failure of re
 | `document_type` is not supplied                                                                                                                        | 400        | Missing document type. It is a required information to be supplied as field 'document_type' of the parameter 'options'. Check the documentation for more information.                                                                                                  |
 | `document_type` is supplied but invalid: empty, null or of a non-acceptable type                                                                       | 400        | The supplied document type is empty or null. It is a required information to be supplied as field 'document_type' of the parameter 'options'. Check the documentation for more information.                                                                            |
 | `document_type` is supplied but indicate a document that type that is not supported                                                                    | 400        | The SnapShot tool does not support this type of document. Check the documentation for more information.                                                                                                                                                                |
-| `supplementary_files` are not JSON well formed                                                                                                         | 400        | The supplementary file list cannot be parsed as a JSON object.                                                                                                                                                                                                         |
+| `supplementary_files` are not well formed JSON                                                                                                         | 400        | The supplementary file list cannot be parsed as a JSON object.                                                                                                                                                                                                         |
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "nodejs-rest-api",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "nodejs REST API to interact with GenShare",
   "main": "src/server.js",
   "engines": {

package.json

@@ -48,7 +48,7 @@ module.exports.getPing = async (req, res) => {
     const allHealthy = [genshareResult, grobidResult, datastetResult]
       .every(service => service.response.status === 200);
 
-    const overallStatus = allHealthy ? 200 : 503;
+    const overallStatus = 200;
 
     res.status(overallStatus).json({
       status: allHealthy ? 'healthy' : 'unhealthy',