Skip to content

docs(cds-connect): add UPSI binding section and cross-link from cds-env - #2973

Open
mariayord wants to merge 3 commits into
mainfrom
vcap-upsi-binding
Open

mariayord wants to merge 3 commits into
mainfrom
vcap-upsi-binding

Conversation

@mariayord

@mariayord mariayord commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

@hyperspace-pr-bot

Copy link
Copy Markdown
Contributor

Control Panel

Hi, I'm an AI-powered Review Bot that helps you with summarizing and reviewing pull requests.
To interact with me, just use the following actions:

  • 📝 Summarize PR
  • 🔍 Review
  • 🗑️ Delete all bot comments and reviews

Comment thread node.js/cds-env.md Resolved
Comment thread node.js/cds-connect.md
Comment on lines +630 to +656
<tr>
<td>

```json
{
"cds": {
"requires": {
"my-service": {
"vcap": { "tag": "my-tag" }
}
}
}
}
```
</td>
<td>

```json
{
"user-provided": [
{ "name": "other-upsi", "tags": ["other-tag"] },
{ "name": "my-upsi", "tags": ["my-tag"] }
]
}
```
</td>
</tr>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
<tr>
<td>
```json
{
"cds": {
"requires": {
"my-service": {
"vcap": { "tag": "my-tag" }
}
}
}
}
```
</td>
<td>
```json
{
"user-provided": [
{ "name": "other-upsi", "tags": ["other-tag"] },
{ "name": "my-upsi", "tags": ["my-tag"] }
]
}
```
</td>
</tr>

Comment thread node.js/cds-connect.md
Comment on lines +526 to +602
<tr>
<td>

```json
{
"cds": {
"requires": {
"my-service": {}
}
}
}
```
</td>
<td>

```json
{
"user-provided": [{
"name": "my-service",
"tags": []
}]
}
```
</td>
</tr>
<tr>
<td>

```json
{
"cds": {
"requires": {
"my-service": {}
}
}
}
```
</td>
<td>

```json
{
"user-provided": [{
"name": "my-upsi",
"tags": ["cds:my-service"]
}]
}
```
</td>
</tr>
<tr>
<td>

```json
{
"cds": {
"requires": {
"my-service": {
"kind": "my-kind"
}
}
}
}
```
</td>
<td>

```json
{
"user-provided": [{
"name": "my-upsi",
"tags": ["my-kind"]
}]
}
```
</td>
</tr>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
<tr>
<td>
```json
{
"cds": {
"requires": {
"my-service": {}
}
}
}
```
</td>
<td>
```json
{
"user-provided": [{
"name": "my-service",
"tags": []
}]
}
```
</td>
</tr>
<tr>
<td>
```json
{
"cds": {
"requires": {
"my-service": {}
}
}
}
```
</td>
<td>
```json
{
"user-provided": [{
"name": "my-upsi",
"tags": ["cds:my-service"]
}]
}
```
</td>
</tr>
<tr>
<td>
```json
{
"cds": {
"requires": {
"my-service": {
"kind": "my-kind"
}
}
}
}
```
</td>
<td>
```json
{
"user-provided": [{
"name": "my-upsi",
"tags": ["my-kind"]
}]
}
```
</td>
</tr>

@sjvans sjvans left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i think we should only list this option:
Image

they can freely choose the name of their user provided service instance, so this option is both easy and 100% reliable

Comment thread node.js/cds-connect.md
Comment on lines +621 to +626
{
"user-provided": [{
"name": "my-upsi",
"tags": []
}]
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
{
"user-provided": [{
"name": "my-upsi",
"tags": []
}]
}
{
"VCAP_SERVICES": {
"user-provided": [{
"name": "my-upsi"
}]
}
}

@mariayord mariayord Oct 30, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@sjvans If you want to point only one option, than it make sense to delete also the clarification:
Because all UPSIs share the same key, matching by kind label or type does not apply — only name and tag matching works. Use an explicit vcap config to override auto-matching

Here the point is that not all rules(1-7) listed above are valid for user-provided case.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

right, it's only rule 7: "The service's vcap.name is matched against the name property". i don't like the tag option because they are not unique → error prone. maybe we say we recommend matching by name above the example?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

but i'd defer to @renejeglinsky and @smahati :)

Co-authored-by: sjvans <30337871+sjvans@users.noreply.github.com>

This branch has not been deployed

No deployments
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