Skip to content

Commit eeeba66

Browse files
committed
docs(AGENTS.md+llms-full+tag-descriptions): add roxy.languages namespace for the new GET /api/v2/languages endpoint shipped in main repo today (2026-05-05, roxyapi commit e269498). Route returns { languages: [{ code, name, nativeName }] } for the 8 supported codes (en, tr, de, es, hi, pt, fr, ru) and is tagged "Languages" in the OpenAPI spec. scripts/tag-descriptions.ts gets a Languages entry mapping to roxy.languages so sync-docs.ts does not fail with "Unknown tag(s) in spec" on next release; without this entry the release gate blocks publish. docs/llms-full.txt gets a new section "Languages, roxy.languages" placed after Usage with a short example calling roxy.languages.listLanguages() and the response shape so sync-docs.ts namespace-presence check passes. AGENTS.md prose updated in 5 spots: intro Eleven to Twelve domains (line 3 now lists ...location, usage, languages), 10-product-domains caption appends "and languages" (line 57), i18n English-only list adds languages plus a runtime hint pointing at roxy.languages.listLanguages() (line 110), priority order list appends Languages (line 141), quick reference table appends a "List supported languages" row mapped to roxy.languages.listLanguages() (line 179). The auto-regenerated BEGIN:DOMAINS table at lines 41-55 was deliberately not edited because sync-docs.ts rebuilds it from specs/openapi.json on next codegen and any manual edit there would be overwritten. specs/openapi.json, src/sdk.gen.ts, and tests/sdk.test.ts will all auto-sync on the next bun run generate + release pipeline run, at which point roxy.languages.listLanguages() becomes a real callable method on the generated Roxy class.
1 parent 09da094 commit eeeba66

3 files changed

Lines changed: 21 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @roxyapi/sdk - Agent Guide
22

3-
TypeScript SDK for RoxyAPI. Eleven domains (Western astrology, Vedic astrology, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, location, usage). One API key, fully typed, zero runtime dependencies.
3+
TypeScript SDK for RoxyAPI. Twelve domains (Western astrology, Vedic astrology, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, location, usage, languages). One API key, fully typed, zero runtime dependencies.
44

55
> Before writing any code with this SDK, read `docs/llms-full.txt` in this package for the complete method reference with examples.
66
@@ -54,7 +54,7 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
5454
| `roxy.usage` | 1 | API usage stats and subscription info |
5555
<!-- END:DOMAINS -->
5656

57-
**Total:** 130 endpoints across 10 product domains plus usage. Counts auto-sync from `specs/openapi.json` at release time.
57+
**Total:** 130 endpoints across 10 product domains plus usage and languages. Counts auto-sync from `specs/openapi.json` at release time.
5858

5959
## Critical patterns
6060

@@ -107,7 +107,7 @@ await roxy.numerology.calculateLifePath({
107107
});
108108
```
109109

110-
Supported: `astrology`, `vedicAstrology`, `numerology`, `tarot`, `biorhythm`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`.
110+
Supported: `astrology`, `vedicAstrology`, `numerology`, `tarot`, `biorhythm`, `iching`, `crystals`, `angelNumbers`. English-only: `dreams`, `location`, `usage`, `languages`. To list supported codes at runtime, call `roxy.languages.listLanguages()`.
111111

112112
### Error handling
113113

@@ -138,7 +138,7 @@ console.log(data.sign, data.overview);
138138

139139
## Common tasks
140140

141-
Ordered by domain priority (Western, Vedic, Numerology, Tarot, Biorhythm, I Ching, Crystals, Dreams, Angel Numbers, Location, Usage).
141+
Ordered by domain priority (Western, Vedic, Numerology, Tarot, Biorhythm, I Ching, Crystals, Dreams, Angel Numbers, Location, Usage, Languages).
142142

143143
| Task | Code |
144144
|------|------|
@@ -177,6 +177,7 @@ Ordered by domain priority (Western, Vedic, Numerology, Tarot, Biorhythm, I Chin
177177
| Universal number lookup | `roxy.angelNumbers.analyzeNumberSequence({ query: { number: '1234' } })` |
178178
| Find city coordinates | `roxy.location.searchCities({ query: { q: 'Mumbai' } })` |
179179
| Check API usage | `roxy.usage.getUsageStats()` |
180+
| List supported languages | `roxy.languages.listLanguages()` |
180181

181182
## Field formats that trip agents
182183

docs/llms-full.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -698,6 +698,17 @@ const { data } = await roxy.usage.getUsageStats();
698698

699699
---
700700

701+
## Languages — `roxy.languages`
702+
703+
List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint. Use to populate language pickers, validate user input before calling chart or reading endpoints, or auto-detect available locales in agent integrations.
704+
705+
```typescript
706+
const { data } = await roxy.languages.listLanguages();
707+
// Returns: { languages: [{ code: 'en', name: 'English', nativeName: 'English' }, ...] }
708+
```
709+
710+
---
711+
701712
## Error Handling
702713

703714
Every method returns `{ data, error, response }`. All errors have `{ error: string, code: string }`:

scripts/tag-descriptions.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,9 @@ export const tagDescriptions: Record<string, TagEntry> = {
8686
readmeDescription: 'API usage stats, rate limits, subscription info',
8787
agentDescription: 'API usage stats and subscription info',
8888
},
89+
Languages: {
90+
namespace: 'roxy.languages',
91+
readmeDescription: 'List supported response languages for the lang query parameter',
92+
agentDescription: 'Supported response languages for the lang query parameter (code, English name, native name)',
93+
},
8994
};

0 commit comments

Comments
 (0)