-
Notifications
You must be signed in to change notification settings - Fork 11
docs: remove API Reference overview pages, fold into endpoints #389
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
Closed
+374
−6
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b93bd30
docs: add generated pages from pipeline run 20260707-205231-consolida…
shirgoldbird 56cf1ae
docs: add generated pages from pipeline run 20260707-205231-consolida…
shirgoldbird be4c81a
docs: consolidate api reference overviews
shirgoldbird d89957e
docs: consolidate API reference overviews into endpoint pages
shirgoldbird 952d111
docs: remove languages overview page missed in consolidation
shirgoldbird b585c36
docs: fold languages use cases into endpoint page, move migration gui…
shirgoldbird b25842c
revert: restore API reference overview pages deleted in consolidation
shirgoldbird 48dd137
docs: add generated pages from pipeline run 20260707-215756-retire-tr…
shirgoldbird File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,11 @@ | ||
| --- | ||
| openapi: get /v3/languages | ||
| title: "Retrieve languages" | ||
| description: "Retrieve supported languages and feature availability for a specific DeepL API resource." | ||
| --- | ||
|
|
||
| Returns the languages supported for a given DeepL API resource, along with feature availability per language (such as formality, glossary support, transcription, and writing style). | ||
|
|
||
| Use the `resource` query parameter to filter results by API product. Supported values include `translate_text`, `translate_document`, `glossary`, `write`, and `voice`. | ||
|
|
||
| This endpoint replaces the deprecated [`GET /v2/languages`](/api-reference/languages/retrieve-supported-languages) endpoint. See the [migration guide](/api-reference/languages/migrate-from-v2-languages) for details. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| openapi: post /v2/translate | ||
| title: "Translate text" | ||
| description: "" | ||
| description: "Translate one or more text strings into a target language." | ||
| --- | ||
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
Oops, something went wrong.
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.
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.
Description not action-oriented for developer learning
The frontmatter description 'Translate one or more text strings into a target language.' is functional but reads as a feature description rather than telling developers what they'll accomplish or learn. Per CLAUDE.md, descriptions should use 'Learn how to X' framing or equivalent.
Suggested fix: Change to: 'Send text to the DeepL API and receive translations in a target language.' This orients the reader toward the action and outcome without being generic.