From 20c4f579af33705fab21d30bb5565854e55968ab Mon Sep 17 00:00:00 2001 From: Christian Georgi Date: Mon, 1 Jun 2026 15:16:01 +0200 Subject: [PATCH 1/2] Hint on `cds-dk` as design-time only package. --- tools/apis/index.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tools/apis/index.md b/tools/apis/index.md index 81292f188..777789999 100644 --- a/tools/apis/index.md +++ b/tools/apis/index.md @@ -12,7 +12,7 @@ This guide is about programmatic CDS design-time APIs. The design-time APIs are provided with package `@sap/cds-dk` which needs to be installed locally in your project: ```sh -npm add @sap/cds-dk +npm add @sap/cds-dk --save-dev ``` That given, you can use the APIs in your project like this: @@ -21,6 +21,10 @@ const cds = require('@sap/cds-dk') cds.import(...) ``` +> [!important] Do not load cds-dk code at runtime +> Note that the `@sap/cds-dk` is a designtime dependency that runs locally or in CI pipelines. +> Avoid loading code like above at application runtime in deployed applications. + From 0d7c68a968a7c9f5e5da8f744ddc2056a02d759f Mon Sep 17 00:00:00 2001 From: Christian Georgi Date: Tue, 2 Jun 2026 10:52:17 +0200 Subject: [PATCH 2/2] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: René Jeglinsky --- tools/apis/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/apis/index.md b/tools/apis/index.md index 777789999..b685c76e9 100644 --- a/tools/apis/index.md +++ b/tools/apis/index.md @@ -21,9 +21,9 @@ const cds = require('@sap/cds-dk') cds.import(...) ``` -> [!important] Do not load cds-dk code at runtime -> Note that the `@sap/cds-dk` is a designtime dependency that runs locally or in CI pipelines. -> Avoid loading code like above at application runtime in deployed applications. +> [!important] Don't load cds-dk code at runtime +> Note that `@sap/cds-dk` is a design-time dependency that runs locally or in continuous integration (CI) pipelines. +> Avoid loading the previously shown code at application runtime in deployed applications.