chore: Add documentation for the transformServiceBindingToClientCredentialsDestination function #1949
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
deekshas8
approved these changes
Nov 21, 2024
| @@ -200,6 +200,44 @@ The SAP Cloud SDK provides a default implementation for the transformation of se | |||
|
|
|||
| The default implementation also retrieves a service token, if needed. | |||
|
|
|||
| Additionally, we provide a default implementation for the transformation of service bindings to OAuth2ClientCredentials destinations. | |||
There was a problem hiding this comment.
Suggested change
| Additionally, we provide a default implementation for the transformation of service bindings to OAuth2ClientCredentials destinations. | |
| Additionally, we provide a function to transform service bindings into OAuth2ClientCredentials destinations, assuming the service binding follows the structure outlined below: |
| @@ -200,6 +200,44 @@ The SAP Cloud SDK provides a default implementation for the transformation of se | |||
|
|
|||
| The default implementation also retrieves a service token, if needed. | |||
|
|
|||
| Additionally, we provide a default implementation for the transformation of service bindings to OAuth2ClientCredentials destinations. | |||
|
|
|||
| It assumes that your service binding is of the following structure: | |||
There was a problem hiding this comment.
Suggested change
| It assumes that your service binding is of the following structure: |
| } | ||
| ``` | ||
|
|
||
| If your service URL is not in the `url` property, you can alternatively provide a `url` property as part of the `options` object. |
There was a problem hiding this comment.
Suggested change
| If your service URL is not in the `url` property, you can alternatively provide a `url` property as part of the `options` object. | |
| If the service URL is not specified in the `url` property, it can alternatively be provided as part of the `options` parameter. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What Has Changed?
This PR describes how to use the newly implemented
transformServiceBindingToClientCredentialsDestinationfunction.