Skip to content

Commit 48e0855

Browse files
sjsyrekclaude
andcommitted
docs: update glossary documentation for v3 API
Update README.md and API.md to reflect v3 glossary API changes: **Key Updates:** - Document single-target and multilingual glossary support - Add `--target` flag requirement for multilingual glossaries - Update output format examples (📖 single-target, 📚 multilingual) - Document v3 PATCH endpoints (no delete+recreate) - Note that glossary IDs remain unchanged with v3 updates - Add multilingual glossary examples throughout - Update behavior notes for all entry operations **README.md Changes:** - Updated glossary section with v3 examples - Added "Key Features" section highlighting v3 capabilities - Updated output examples to show v3 structure **API.md Changes:** - Added v3 API description to glossary section - Updated all subcommand signatures with `[--target <lang>]` - Documented smart defaults (--target optional for single-target) - Updated behavior descriptions for PATCH endpoints - Added multilingual glossary examples for all commands 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6b3bea7 commit 48e0855

2 files changed

Lines changed: 152 additions & 64 deletions

File tree

README.md

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -789,50 +789,52 @@ auto_commit = true
789789

790790
### Glossaries
791791

792-
DeepL glossaries ensure consistent terminology across translations.
792+
DeepL glossaries ensure consistent terminology across translations. The v3 Glossary API supports both single-target and multilingual glossaries (one glossary with multiple target languages).
793793

794794
```bash
795-
# Create a glossary from TSV file
795+
# Create a single-target glossary from TSV file
796796
# File format: source_term<TAB>target_term per line
797797
echo -e "API\tAPI\nREST\tREST\nauthentication\tAuthentifizierung" > glossary.tsv
798798
deepl glossary create tech-terms en de glossary.tsv
799799
# ✓ Glossary created: tech-terms (ID: abc123...)
800-
# Language pair: EN → DE
801-
# Entries: 3
800+
# Source language: EN
801+
# Target languages: DE
802+
# Type: Single target
803+
# Total entries: 3
802804

803805
# List all glossaries
804806
deepl glossary list
805-
# Glossaries:
806-
#
807-
# Name: tech-terms
808-
# ID: abc123...
809-
# Languages: EN → DE
810-
# Entries: 3
811-
# Created: 2024-10-07
807+
# 📖 tech-terms (en→de) - 3 entries
808+
# 📚 multilingual-terms (en→3 targets) - 15 entries
812809

813810
# Show glossary details
814811
deepl glossary show tech-terms
815-
# Glossary: tech-terms
812+
# Name: tech-terms
816813
# ID: abc123...
817-
# Language Pair: EN → DE
818-
# Entry Count: 3
814+
# Source language: en
815+
# Target languages: de
816+
# Type: Single target
817+
# Total entries: 3
819818
# Created: 2024-10-07T12:34:56Z
820819

821-
# Show glossary entries
820+
# Show glossary entries (single-target glossary - no --target flag needed)
822821
deepl glossary entries tech-terms
823-
# Entries for glossary 'tech-terms':
824-
#
825822
# API → API
826823
# REST → REST
827824
# authentication → Authentifizierung
828825

826+
# Show entries for multilingual glossary (--target flag required)
827+
deepl glossary entries multilingual-terms --target es
828+
# API → API
829+
# cache → caché
830+
# ...
831+
829832
# Delete glossary
830833
deepl glossary delete tech-terms
831834
# ✓ Glossary deleted: tech-terms
832835

833836
# List supported glossary language pairs
834837
deepl glossary languages
835-
# Supported glossary language pairs:
836838
# de → en
837839
# de → fr
838840
# de → it
@@ -846,27 +848,21 @@ deepl glossary languages
846848
# Add a new entry to an existing glossary
847849
deepl glossary add-entry tech-terms "database" "Datenbank"
848850
# ✓ Entry added successfully
849-
# Glossary: tech-terms
850-
# Entries: 4
851+
852+
# Add entry to multilingual glossary (requires --target flag)
853+
deepl glossary add-entry multilingual-terms "cache" "caché" --target es
851854

852855
# Update an existing entry in a glossary
853856
deepl glossary update-entry tech-terms "API" "API (Programmierschnittstelle)"
854857
# ✓ Entry updated successfully
855-
# Glossary: tech-terms
856-
# Entries: 4
857858

858859
# Remove an entry from a glossary
859860
deepl glossary remove-entry tech-terms "REST"
860861
# ✓ Entry removed successfully
861-
# Glossary: tech-terms
862-
# Entries: 3
863862

864863
# Rename a glossary
865864
deepl glossary rename tech-terms "Technical Terms v2"
866865
# ✓ Glossary renamed successfully
867-
# Name: Technical Terms v2
868-
# ID: def456... (new ID)
869-
# Entries: 3
870866
```
871867

872868
**Glossary file format (TSV):**
@@ -878,6 +874,14 @@ REST REST
878874
authentication Authentifizierung
879875
```
880876

877+
**Key Features:**
878+
879+
- **Single-target glossaries** - One source language → one target language (e.g., EN → DE)
880+
- **Multilingual glossaries** - One source language → multiple target languages (e.g., EN → ES, FR, DE)
881+
- **Direct updates** - v3 API uses PATCH endpoints for efficient updates (no delete+recreate)
882+
- **Smart defaults** - `--target` flag only required for multilingual glossaries
883+
- **Visual indicators** - 📖 for single-target, 📚 for multilingual glossaries
884+
881885
**Note:** Using glossaries in translation (`--glossary` flag) is supported by the API client. Full CLI integration with automatic glossary application is planned for a future release.
882886

883887
### Cache Management

0 commit comments

Comments
 (0)