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.

Sign up for GitHub

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

Restructure Remote Service doc for Java to include Service Binding based services #732

Merged
merged 44 commits into from
Apr 2, 2024
Merged

Restructure Remote Service doc for Java to include Service Binding based services #732

Show file tree
Hide file tree
Changes from 33 commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
61d3afe
first draft of structure
StefanHenke Mar 8, 2024
a5fa383
fix broken link
StefanHenke Mar 8, 2024
caefa6d
fix broken link
StefanHenke Mar 8, 2024
3b6efe1
resolve conflicts
renejeglinsky Mar 11, 2024
0fc110d
fix links
renejeglinsky Mar 11, 2024
61dbf5e
fix anchor
renejeglinsky Mar 11, 2024
b9d0e99
incorporate feedback
StefanHenke Mar 19, 2024
a4bad32
Merge branch 'binding-based-remote-service' of https://github.com/cap…
StefanHenke Mar 19, 2024
3301dfc
incorporate feedback
StefanHenke Mar 19, 2024
8d0965e
incorporate feedback
StefanHenke Mar 19, 2024
584abba
incorporate feedback
StefanHenke Mar 20, 2024
0d484ee
incorporate feedback
StefanHenke Mar 20, 2024
8ef8421
fix issue caused by conflict resolution
StefanHenke Mar 20, 2024
3418905
Apply suggestions from code review
StefanHenke Mar 20, 2024
6954d56
Apply suggestions from code review
StefanHenke Mar 20, 2024
10c0ab4
Apply suggestions from code review
StefanHenke Mar 20, 2024
f68d975
incorporate feedback
StefanHenke Mar 20, 2024
80b5034
incorporate feedback
StefanHenke Mar 21, 2024
ba8c16e
Apply suggestions from code review
StefanHenke Mar 21, 2024
f12d371
Merge branch 'main' into binding-based-remote-service
StefanHenke Mar 21, 2024
126dbea
fix links
StefanHenke Mar 21, 2024
5d5b667
Merge branch 'binding-based-remote-service' of https://github.com/cap…
StefanHenke Mar 21, 2024
c8219f8
native consumption
StefanHenke Mar 21, 2024
60c7430
fix broken links
StefanHenke Mar 21, 2024
93931e8
fix broken links
StefanHenke Mar 21, 2024
998f4dd
fix broken links
StefanHenke Mar 21, 2024
7e343cf
fix broken links
StefanHenke Mar 21, 2024
fd84425
fix broken links
StefanHenke Mar 21, 2024
3bc40d5
fix broken links
StefanHenke Mar 22, 2024
f0dc5d6
Some changes in binding section
Mar 21, 2024
c1d293d
restructured sections
Mar 22, 2024
9ce75fa
Update java/cqn-services/remote-services.md
StefanHenke Mar 22, 2024
c255b76
adjust service name
StefanHenke Mar 26, 2024
d9c69ba
Apply suggestions from code review
StefanHenke Mar 26, 2024
00548ad
Apply suggestions from code review
StefanHenke Mar 27, 2024
a06547a
Update remote-services.md
StefanHenke Mar 27, 2024
5e751a6
adapted font family
renejeglinsky Apr 2, 2024
ac11db6
Update java/cqn-services/remote-services.md
StefanHenke Apr 2, 2024
1862599
edit
renejeglinsky Apr 2, 2024
678e25c
Merge branch 'binding-based-remote-service' of https://github.com/cap…
renejeglinsky Apr 2, 2024
a87e75d
Update java/cqn-services/remote-services.md
renejeglinsky Apr 2, 2024
b62081a
Update java/cqn-services/remote-services.md
StefanHenke Apr 2, 2024
46eae7f
Merge branch 'main' into binding-based-remote-service
renejeglinsky Apr 2, 2024
89ea869
fix links
renejeglinsky Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions guides/using-services.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this guide needs to be adapted overall. It still deprecated property structures in a lot of areas, due to our latest changes. Also we should at least mention somewhere that in Java the new binding-based destinations are available (see also concerns below)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I adapted all configurations. The whole guide focuses a lot on destinations, I was not aware of that guide before. Not sure if we need to adapt the guide on a second step to describe the binding-based approach more prominently.

Original file line number Diff line number Diff line change
Expand Up @@ -1032,7 +1032,7 @@ cds:
type: "odata-v2"
```

[Learn more about configuring destinations for Java.](../java/cqn-services/remote-services#configuring-the-destination){.learn-more}
[Learn more about configuring destinations for Java.](../java/cqn-services/remote-services#destination-based-scenarios){.learn-more}

#### Use Application Defined Destinations { #app-defined-destinations}

Expand Down Expand Up @@ -1666,10 +1666,10 @@ This list specifies the properties for application defined destinations.

#### Authentication Types

| Authentication Types | Java | Node.js |
|-------------------------|:-----------------------------------------------------------------:|:------------------------------:|
| NoAuthentication | <Y/> | <Y/> |
| BasicAuthentication | <Y/> | <Y/> |
| TokenForwarding | <Y/> | <X/><br>Use `forwardAuthToken` |
| OAuth2ClientCredentials | [code only](../java/cqn-services/remote-services#oauth2-client-credentials) | <X/> |
| UserTokenAuthentication | [code only](../java/cqn-services/remote-services#user-token-authentication) | <X/> |
| Authentication Types | Java | Node.js |
|-------------------------|:-----------------------------------------------------------------------:|:------------------------------:|
| NoAuthentication | <Y/> | <Y/> |
| BasicAuthentication | <Y/> | <Y/> |
| TokenForwarding | <Y/> | <X/><br>Use `forwardAuthToken` |
| OAuth2ClientCredentials | [code only](../java/cqn-services/remote-services#register-destinations) | <X/> |
| UserTokenAuthentication | [code only](../java/cqn-services/remote-services#register-destinations) | <X/> |
Comment on lines +1674 to +1675
Copy link
Contributor

Choose a reason for hiding this comment

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

code only is slightly misleading here now. I think we should make clear that this also works via configuration now (maybe simply <Y/> and link to our docs).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. I have linked to our new binding-based approach. I guess this should be the preferred way over programmatically registering destinations

4 changes: 4 additions & 0 deletions java/assets/remote services.drawio.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading