Skip to content

Commit 22fb705

Browse files
committed
Add docs remoteflowsource cap
1 parent 9912a37 commit 22fb705

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

javascript/frameworks/cap/lib/advanced_security/javascript/frameworks/cap/RemoteFlowSources.qll

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,19 @@ import javascript
22
import advanced_security.javascript.frameworks.cap.CDS
33

44
/**
5-
* Either a service is known and is exposed
6-
* or
7-
* there is a handler parameter that is not connected to a service
8-
* possibly due to cds compilation failure
9-
* or non explicit service references in source
10-
* for example:
5+
* Either of:
6+
* a parameter of a handler registered for an (exposed) service on an event. e.g.
7+
* ```javascript
8+
* this.on("SomeEvent", "SomeEntity", (req) => { ... });
9+
* this.before("SomeEvent", "SomeEntity", (req, next) => { ... });
10+
* SomeService.on("SomeEvent", "SomeEntity", (msg) => { ... });
11+
* SomeService.after("SomeEvent", "SomeEntity", (msg) => { ... });
1112
* ```
13+
* OR
14+
* a handler parameter that is not connected to a service
15+
* possibly due to cds compilation failure
16+
* or non explicit service references in source. e.g.
17+
* ```javascript
1218
* cds.serve('./test-service').with((srv) => {
1319
* srv.after('READ', req => req.target.data) //req
1420
* })

0 commit comments

Comments
 (0)