docs: relationships and links resolving in README #48
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.
This PR adds some details about the behavior of relationships and links resolving that has been introduced with the update to the V2 of the REST API as the default version in the client. This change in the client was approved and published a long time ago but I think it's better to document clearly this behaviour.
Pull request type
Internal - no Jira link
How to test this PR
If you want to double-check the behavior, you can run this script that will fetch a story that has a reference to a story, that has a reference to another story. You can then check the returned data and see the injected stories in the
rel
field (2 levels of nesting):