From 0d106d6fe9757fa3c8dfe34d60e9caf13baba608 Mon Sep 17 00:00:00 2001 From: DJ Adams Date: Wed, 8 Jul 2026 08:24:41 +0100 Subject: [PATCH] try to improve accuracy & detail of cds export example in cds-cli.md The command shown `cds export srv/data-services.cds` does not include any options and so the screenshot shows an outcome that is not representative. Thus I've reworked the text below the screenshot to include more detail (including changing the term "test data" to "initial data" to align with [what we should (?) be saying](https://qmacro.org/blog/posts/2026/05/11/local-first-dev-with-cap-node-js-mocking-data/#initial-test-and-sample-data-terminology) (please change back to "test" if you see fit). --- tools/cds-cli.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/tools/cds-cli.md b/tools/cds-cli.md index f5560551d..b482c836d 100644 --- a/tools/cds-cli.md +++ b/tools/cds-cli.md @@ -503,9 +503,11 @@ The command generates the API client package into a new folder _apis/data-servic ![The screenshot is described in the accompanying text.](assets/cds-export.png) {style="filter: drop-shadow(0 2px 5px rgba(0,0,0,.40));"} The `service.csn` contains only the interface defined in the service, removing the query part of the entities and all the underlying model. -In addition, there are i18n bundles with the localized metadata relevant -for the interface, and a _data_ folder with test data -that exactly matches the structure of the entities in the API. +In addition (and as shown in the screenshot): + +- with the `--texts` option, i18n bundles are included with the localized metadata relevant for the interface +- with the `--data` option, initial data that exactly matches the structure of the entities in the API is included +- with the `--plugin` option, a `cds-plugin.js` entrypoint file is included for plug & play `cds export` also adds a _package.json_. The package name combines the application name (from the main _package.json_) with the file name of the data service. In our example, this results in `@capire/xflights-data-service`. You can change this name as appropriate.