fix(122): always use full resource path for API references #343
Conversation
This file contains hidden or 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
The previous guidance was ambiguous about when to use a full resource name vs a relative one. This ambiguity makes it difficult for clients to read the location of the remote resource, as well as the ablity to resolve it as necessary. Some forms of REST APIs already put the full resource name directly in the payload, so there is precedence for this approach. Clarifying the guidance to ensure consistent behavior for APIs.
toumorokoshi
added
the
discussion
toumorokoshi
removed
the
discussion
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.
The previous guidance was ambiguous about when to use a full resource name vs a relative one.
This ambiguity makes it difficult for clients to read the location of the remote resource, as well as the ablity to resolve it as necessary.
Some forms of REST APIs already put the full resource name directly in the payload, so there is precedence for this approach.
Clarifying the guidance to ensure consistent behavior for APIs.
fixes #264
🍱 Types of changes
What types of changes does your code introduce to AEP? Put an
xin the boxesthat apply
📋 Your checklist for this pull request
Please review the AEP Style and Guidance for
contributing to this repository.
General
references AEPs
correctly.
(usually
prettier -w .)💝 Thank you!