-
Notifications
You must be signed in to change notification settings - Fork 0
added language about api-us #183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds documentation clarifying that clients using the api-us.deepl.com endpoint cannot access glossaries or style rules created in the UI, addressing an important API limitation for US data center users.
Key Changes:
- Added explicit notice in both glossaries and style rules documentation about
api-us.deepl.comendpoint limitations - Clarified that UI-created resources are not accessible via the US API endpoint
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| api-reference/style-rules.mdx | Added sentence explaining that api-us.deepl.com endpoint users cannot access UI-created style rules |
| api-reference/multilingual-glossaries.mdx | Added Info callout box explaining that api-us.deepl.com endpoint users cannot access UI-created glossaries |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
shirgoldbird
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nits
|
|
||
| Use this endpoint to list all your glossaries, basic information about each glossary's dictionaries, and each glossary's name and creation time. The response will not include any dictionary entries. | ||
|
|
||
| <Info> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would this section be better further up in the doc under ## Creating glossaries?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found the beginning of this language right above creating glossaries, bottom of overview section so adding this there.
api-reference/style-rules.mdx
Outdated
| You can create style rules in the UI at [https://deepl.com/custom-rules](https://deepl.com/custom-rules). | ||
|
|
||
| Both style rules and glossaries are unique to each global data center and are not shared between them. | ||
| Both style rules and glossaries are unique to each global data center and are not shared between them. Clients using the `api-us.deepl.com` endpoint will not be able to access glossaries or style rules created in the UI at this time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Both style rules and glossaries are unique to each global data center and are not shared between them. Clients using the `api-us.deepl.com` endpoint will not be able to access glossaries or style rules created in the UI at this time. | |
| Both style rules and glossaries are unique to each of DeepL's global data centers and are not shared between them. Clients using the `api-us.deepl.com` endpoint will not be able to access glossaries or style rules created in the UI at this time. |
Co-authored-by: Shir Goldberg <3937986+shirgoldbird@users.noreply.github.com>
Co-authored-by: Shir Goldberg <3937986+shirgoldbird@users.noreply.github.com>
edited 2 files (glossaries and style rules) to be more explicit about api-us endpoint not retrieving those created in UI.