Skip to content

Commit 11386b0

Browse files
committed
ai-supported edit for simpler formulations
1 parent d1ea9e9 commit 11386b0

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

get-started/get-help.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To start VS Code via the `code` CLI, users on macOS must first run a command (*S
3434

3535
### Check the Node.js version { #node-version}
3636

37-
Verify that you run the latest long-term support (LTS) version of Node.js with an even number like `20`, `22`, `24`, and so on. Refrain from using odd versions, for which some modules with native parts will have no support and thus might even fail to install. Check version with:
37+
Run the latest LTS version of Node.js (even numbers: 20, 22, 24). Avoid odd versions, as some modules with native parts may not install. Check version with:
3838

3939
```sh
4040
node -v
@@ -48,7 +48,7 @@ For [Cloud Foundry](https://docs.cloudfoundry.org/buildpacks/node/index.html#run
4848

4949
### Check access permissions on macOS or Linux
5050

51-
In case you get error messages like `Error: EACCES: permission denied, mkdir '/usr/local/...'` when installing a global module like `@sap/cds-dk`, configure `npm` to use a different directory for global modules:
51+
If you get error messages like `Error: EACCES: permission denied, mkdir '/usr/local/...'` when installing a global module like `@sap/cds-dk`, configure `npm` to use a different directory for global modules:
5252

5353
```sh
5454
mkdir ~/.npm-global ; npm set prefix '~/.npm-global'
@@ -72,7 +72,7 @@ Verify that your `PATH`-environment variable contains this path.
7272
In addition, set the variable `NODE_PATH` to: <br /> ``C:\Users\<your-username>\AppData\Roaming\npm\node_modules``.
7373

7474

75-
### How to consume a new version of CDS? { #cds-versions}
75+
### Updating CDS Versions { #cds-versions}
7676

7777
* Design time tools like `cds init`:
7878

@@ -136,9 +136,9 @@ cds.on('served', async ()=>{
136136

137137
### Why does my app not show up in Dynatrace?
138138

139-
Make sure that:
140-
- Your app's start script is `cds-serve` instead of `npx cds run`.
141-
- You have the dependency `@dynatrace/oneagent-sdk` in your _package.json_.
139+
Requirements:
140+
- App start script is `cds-serve` (not `npx cds run`)
141+
- Dependency `@dynatrace/oneagent-sdk` is in _package.json_
142142

143143
### Why are requests rejected with HANA timeout errors?
144144

@@ -234,8 +234,8 @@ module.exports = cds.server
234234
| _Solution 2_ | Try `npm rebuild` or add `@cap-js/cds-types` in your _tsconfig.json_. |
235235

236236

237-
#### Install package as dev dependency
238-
The type definitions for `@sap/cds` are maintained in a separate package `@cap-js/cds-types` and have to be explicitly installed as a dev dependency. This can be done by adding the `typescript` facet:
237+
#### Install as dev dependency
238+
Install type definitions by adding the `typescript` facet:
239239

240240
::: code-group
241241
```sh [facet]
@@ -250,7 +250,7 @@ npm i -D @cap-js/cds-types
250250

251251
Installing `@cap-js/cds-types` leverages VS Code's automatic type resolution mechanism by symlinking the package in `node_modules/@types/sap__cds` in a postinstall script. If you find that this symlink is missing, try `npm rebuild` to trigger the postinstall script again.
252252

253-
If the symlink still does not persist, you can explicitly point the type resolution mechanism to `@cap-js/cds-types` in your _tsconfig.json_:
253+
If the symlink doesn't persist, explicitly configure _tsconfig.json_:
254254

255255
::: code-group
256256
```json [tsconfig.json]
@@ -262,30 +262,27 @@ If the symlink still does not persist, you can explicitly point the type resolut
262262
```
263263
:::
264264

265-
If you find that the types are still incomplete, open a bug report in [the `@cap-js/cds-types` repository](https://github.com/cap-js/cds-types/issues/new/choose).
265+
For incomplete types, report issues in [the `@cap-js/cds-types` repository](https://github.com/cap-js/cds-types/issues/new/choose).
266266

267267

268268

269269

270270
### How to fix "`tar: Error is not recoverable: exiting now`"?
271271

272-
If you get the error `tar: Error is not recoverable: exiting now` (for example, when building MTX resources)
273-
you can try installing the tar library for better compatibility with Windows systems.
274-
275-
Add it to your devDependencies like so:
272+
If you get this error (for example, when building MTX resources), install the tar library for better Windows compatibility:
276273

277274
```sh
278275
npm add -D tar
279276
```
280-
On macOS and Linux, the built-in implementation will continue to be used.
277+
On macOS and Linux, the built-in implementation continues to be used.
281278

282279

283280

284281
## Java
285282

286-
### How can I make sure that a user passes all authorization checks?
283+
### How to bypass authorization checks?
287284

288-
A new option `privilegedUser()` can be leveraged when [defining](../java/event-handlers/request-contexts#defining-requestcontext) your own `RequestContext`. Adding this introduces a user, which passes all authorization restrictions. This is useful for scenarios, where a restricted service should be called through the [local service consumption API](../java/services) either in a request thread regardless of the original user's authorizations or in a background thread.
285+
Use `privilegedUser()` when [defining](../java/event-handlers/request-contexts#defining-requestcontext) your own `RequestContext`. This introduces a user that passes all authorization restrictions. Useful when calling a restricted service through the [local service consumption API](../java/services) regardless of the original user's authorizations or in a background thread.
289286

290287
### Why do I get a "User should not exist" error during build time?
291288

@@ -319,8 +316,9 @@ To fix this, either switch the Node.js version using a Node version manager, or
319316

320317
### How can I expose custom REST APIs with CAP?
321318

322-
You might want to expose additional REST APIs in your CAP application that aren't covered through CAP's existing protocol adapters (for example, OData V4). A common example is a CSV file upload or another type of custom REST endpoint.
323-
In that case, you can leverage the powerful capabilities of Spring Web MVC by implementing your own RestController. From within your RestController implementation, you can fully leverage all CAP Java APIs. Most commonly you'll be interacting with your services and the database through the [local service consumption API](../java/services). To learn more about Spring Web MVC, see the [Spring docs](https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc), [Spring Boot docs](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-spring-mvc), and this [tutorial](https://spring.io/guides/gs/serving-web-content/).
319+
To expose additional REST APIs not covered by CAP's protocol adapters (for example, OData V4), implement your own Spring Web MVC RestController. Common examples include CSV file uploads or custom REST endpoints.
320+
321+
Your RestController can fully leverage CAP Java APIs. You'll typically interact with services and the database through the [local service consumption API](../java/services). Learn more: [Spring docs](https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc), [Spring Boot docs](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-spring-mvc), and this [tutorial](https://spring.io/guides/gs/serving-web-content/).
324322

325323
### How can I build a CAP Java application without SQL database?
326324

0 commit comments

Comments
 (0)