Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Event hub java docs #1658

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Event hub java docs #1658

wants to merge 9 commits into from

Conversation

t-bonk
Copy link
Contributor

@t-bonk t-bonk commented Feb 20, 2025

No description provided.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling Mistakes

  • java/messaging.md:291:7 Unknown word "asynchronuos"
  • java/messaging.md:291:34 Unknown word "usign"

Generally, for each spelling mistake there are 2 ways to fix it:

  1. Fix the spelling mistake and commit it.
  2. The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.

# unique identifier for this event broker instance
# should start with own namespace (i.e., "foo.bar") and may not be longer than 15 characters
systemNamespace: cap.service
webhookUrl: ~{srv-api/srv-cert-url}/messaging/v1.0/eb
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We cannot assume that the `srv-cert-url´ property is always available in a given customer mta. They would have to additionally bind the corresponding route in their CAP Java backend.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BraunMatthias : What do you think if we create a dedicated section how to configure the app with a .cert in a central place? We have some sort of half ready documentation already spread across SMS and IAS. But no central one which we can simple link from locations like this here.

config:
# unique identifier for this event broker instance
# should start with own namespace (i.e., "foo.bar") and may not be longer than 15 characters
systemNamespace: cap.service
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn´t match the docs from EventHub I guess. Doesn´t this need to be ceSource? https://help.sap.com/docs/sap-cloud-application-event-hub/sap-cloud-application-event-hub-stakeholder-guide/create-service-instance-for-sap-cloud-applications and search for "single tenancy". The system namespace pops up here magically. We need to provide some information where to get this information.

messaging.services:
- name: "eventhub-messaging"
kind: "event-hub"
binding: "event-broker"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this matches the name of the service binding, right? I would avoid mixing "event-hub" and "event-broker" in the configuration. Maybe "event-hub-binding" produces less confusion

kind: "enterprise-messaging"
```
:::


#### Configuring SAP Cloud Application Event Hub Support: <Beta/> { #configuring-sap-event-hub-support}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this chapter, the page is getting pretty long. What about moving out the section "Supported Message Brokers" into a dedicated subpage?

messaging.services:
- name: "eventhub-messaging"
kind: "event-hub"
binding: "event-broker"
Copy link
Contributor

@StefanHenke StefanHenke Feb 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
binding: "event-broker"
binding: "<event-hub-binding>"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants