docs: improve error message for server-side APIs#1545
Closed
yigitozgul14 wants to merge 2 commits intoappwrite:mainfrom
Closed
docs: improve error message for server-side APIs#1545yigitozgul14 wants to merge 2 commits intoappwrite:mainfrom
yigitozgul14 wants to merge 2 commits intoappwrite:mainfrom
Conversation
Updated the error message when viewing server-side APIs in client SDK documentation to be more descriptive and provide clearer guidance to users. Fixes #7720
|
The preview deployment is ready. 🟢 Open Preview | Open Build Logs Last updated at: 2024-12-10 18:54:29 CET |
loks0n
requested changes
Jan 31, 2025
| <span class="icon-info" aria-hidden="true" /> | ||
| <h5 class="text-sub-body text-primary font-medium"> | ||
| No endpoint found for this version and platform | ||
| This API is a Server Side API Component, not available on Client SDKs |
Member
There was a problem hiding this comment.
We generally prefer to use sentence case. This capitalisation doesn't match our style guide.
| This API is a Server Side API Component, not available on Client SDKs | ||
| </h5> | ||
| Please switch to a newer version or different platform. | ||
| Please select Server SDKs from the language selector at the top of this section. |
Member
There was a problem hiding this comment.
I'm not sure this is an improvement, it's longer and reads a bit off
TorstenDittmann
force-pushed
the
main
branch
5 times, most recently
from
6e3c6b4 to
83e3ebc
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
2 participants
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 does this PR do?
This PR improves the error message shown to users when they try to access server-side APIs (like Users & Messaging) in the client SDK documentation. The current message "No endpoint found for this version and platform" is not accurate and can be confusing.
The new message clearly indicates that these APIs are server-side components and guides users to select Server SDKs from the language selector, providing a better user experience and clearer documentation.
Test Plan
Related PRs and Issues
Have you read the Contributing Guidelines on issues?
Yes, I have read and followed the contributing guidelines. This PR follows the guidelines by:
doc-7720-improve-server-api-unavailable-message)