docs(API): Add warning about trailing slash characters#1086
Merged
JohnVillalovos merged 1 commit intodevelopfrom Feb 26, 2026
Merged
docs(API): Add warning about trailing slash characters#1086JohnVillalovos merged 1 commit intodevelopfrom
JohnVillalovos merged 1 commit intodevelopfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds a general warning at the beginning of the "Getting Started With the API" section about the importance of trailing slash characters in API URLs. The documentation already contains multiple endpoint-specific notes about this requirement, and this change provides an upfront general warning to help API consumers understand this critical behavior before they encounter individual endpoints.
Changes:
- Added an
.. important::admonition block warning users about trailing slash requirements in API URLs
JohnVillalovos
force-pushed
the
jlvillal/api_note
branch
2 times, most recently
from
7dfd93c to
d249a2c
Compare
JohnVillalovos
force-pushed
the
jlvillal/api_note
branch
from
d249a2c to
f5c2edb
Compare
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
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.
No description provided.