From a206d48dbfa4496f5faaceb23a3947a421cf6dca Mon Sep 17 00:00:00 2001 From: Claire Lovisa Date: Tue, 3 Oct 2023 15:47:23 +0200 Subject: [PATCH] Update documentation --- README.md | 11 ++++------- app.js | 2 -- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e17de75..668e8ea 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,9 @@ This service maintains OP's OVO numbers in sync together with [Wegwijs](https://wegwijs.vlaanderen.be/#/organisations), which is the official source of OVO numbers. -It gets triggered when a KBO is updated in OP as well as on a regular basis via a cron job to ensure our dataset is in sync with theirs. +It gets triggered when a KBO is added or updated in OP, as well as on a regular basis via a cron job to ensure our dataset is in sync with theirs. + +*Note: Wegwijs currently (03/10/2023) don't have all the KBOs added in their database. For this reason, the behaviour we follow when we can't find a match on a KBO between OP and them is to leave the OVO number of OP untouched if it exists.*

(back to top)

@@ -35,17 +37,12 @@ It gets triggered when a KBO is updated in OP as well as on a regular basis via logging: *default-logging ``` -### 🗒️ Config - -// TODO probably no delta config if we go for the endpoint option right ? -

(back to top)

## 🔑 Environment variables | ENV | description | default | required | |---|---|---|---| -| xxx | xxx | | X | - +| CRON_PATTERN | Cron pattern describing when the healing runs | '0 0 0 * * *' | |

(back to top)

diff --git a/app.js b/app.js index 9bee86b..bb343ed 100644 --- a/app.js +++ b/app.js @@ -9,8 +9,6 @@ import { } from "./lib/queries"; import { CRON_PATTERN } from './config'; -// TODO update readme with env variables etc at the end - app.post('/sync-from-kbo/:kboStructuredIdUuid', async function(req, res) { try { const kboStructuredIdUuid = req.params.kboStructuredIdUuid;