chore: Add serialization docs #1607
Merged
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
marikaner
approved these changes
Nov 24, 2023
| To configure the serialization of the URLs within a batch request, you can set the subrequest path type with the `withSubRequestPathType()` method. | ||
| You can either set it to `relativeToService` (default), which will yield URLs relative to the entity, or `absolute`, which will produce absolute URLs. | ||
| To configure the serialization of the URLs within a batch request, you can set the subrequest path type using the `withSubRequestPathType()` method. | ||
| You can choose from the following options: `relativeToService` (default), which yields URLs relative to the service; `relativeToEntity`, which yields URLs relative to the entity; `absolute`, which produces absolute URLs; or `noPath`, which only returns the entity with no preceding path. |
There was a problem hiding this comment.
[pp] I am not a fan of the semicolon list, how about a list?
[nth] Maybe consider additionally mentioning that noPath is the same as relativetoEntity without leading slash
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?
With this PR, the changes in SAP/cloud-sdk-js#4295 are reflected.