Skip to content

Commit 38815ec

Browse files
authored
chore: move docs from capire to readme (#26)
1 parent aa3164a commit 38815ec

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ CDS plugin providing integration with SAP Cloud Application Event Hub (technical
2323

2424
## Requirements
2525

26-
See [Getting Started](https://cap.cloud.sap/docs/get-started/in-a-nutshell) on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model.
26+
See [Getting Started](https://cap.cloud.sap/docs/get-started/in-a-nutshell) on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model (CAP).
27+
To learn about messaging in CAP, please consult the guide on [Events & Messaging](https://cap.cloud.sap/docs/guides/messaging/).
2728

2829

2930

@@ -35,23 +36,36 @@ Install the plugin via:
3536
npm add @cap-js/event-broker
3637
```
3738

38-
Please follow the [guide on messaging](https://cap.cloud.sap/docs/guides/messaging/) to get an overview over the messaging concepts of CAP.
39+
Then, set the `kind` of your messaging service to `event-broker`:
3940

40-
You can create an SAP Cloud Application Event Hub service with the following configuration:
41+
```jsonc
42+
"cds": {
43+
"requires": {
44+
"messaging": {
45+
"kind": "event-broker"
46+
}
47+
}
48+
}
49+
```
50+
51+
The [CloudEvents](https://cloudevents.io/) format is enforced since it is required by SAP Cloud Application Event Hub.
52+
53+
Authentication in the SAP Cloud Application Event Hub integration is based on the [Identity Authentication service (IAS)](https://help.sap.com/docs/cloud-identity-services/cloud-identity-services/getting-started-with-identity-service-of-sap-btp) of [SAP Cloud Identity Services](https://help.sap.com/docs/cloud-identity-services).
54+
If you are not using [IAS-based Authentication](https://cap.cloud.sap/docs/node.js/authentication#ias), you will need to trigger the loading of the IAS credentials into your app's `cds.env` via an additional `requires` entry:
4155

4256
```jsonc
43-
{
44-
"cds": {
45-
"requires": {
46-
"messaging": {
47-
"kind": "event-broker"
57+
"cds": {
58+
"requires": {
59+
"ias": { // any name
60+
"vcap": {
61+
"label": "identity"
4862
}
4963
}
5064
}
5165
}
5266
```
5367

54-
For more details, please refer to the [messaging section](https://cap.cloud.sap/docs/node.js/messaging) of the CAP Node.js documentation.
68+
For more information, please see [SAP Cloud Application Event Hub](https://help.sap.com/docs/sap-cloud-application-event-hub) in SAP Help Portal.
5569

5670

5771

0 commit comments

Comments
 (0)