Skip to content

Commit b748d0f

Browse files
committed
docs: eighteen domains and 258+ endpoints on one key; ci: hook commands lefthook can parse
1 parent ee97db3 commit b748d0f

3 files changed

Lines changed: 9 additions & 5 deletions

File tree

AGENTS.md

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

3-
PHP SDK for RoxyAPI. 14+ domains (Western astrology, Vedic astrology, forecast, human design, Chinese astrology, feng shui, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, location) plus utility namespaces (usage, languages). One API key, one Composer package, zero hand-written endpoint code.
3+
PHP SDK for RoxyAPI. 18+ domains (Western astrology, Vedic astrology, forecast, human design, Chinese astrology, feng shui, Mesoamerican astrology, Vastu, numerology, Kabbalah, tarot, biorhythm, Ayurveda, I Ching, crystals, dreams, angel numbers, location) plus utility namespaces (usage, languages). One API key, one Composer package, zero hand-written endpoint code.
44

55
## Install and initialize
66

@@ -58,7 +58,7 @@ $result = $roxy->location->searchCities(q: 'New York');
5858
| `$roxy->languages` | List the response languages accepted by the `lang` query parameter on every i18n-aware endpoint |
5959
<!-- END:DOMAINS -->
6060

61-
209+ endpoints across 14+ product domains plus usage and languages. The table above auto-syncs from `specs/openapi.json` at release time.
61+
258+ endpoints across 18+ product domains plus usage and languages. The table above auto-syncs from `specs/openapi.json` at release time.
6262

6363
## Critical patterns
6464

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[![Packagist](https://img.shields.io/packagist/v/roxyapi/sdk.svg)](https://packagist.org/packages/roxyapi/sdk)
1010
[![PHP Version](https://img.shields.io/packagist/php-v/roxyapi/sdk.svg)](https://packagist.org/packages/roxyapi/sdk)
1111

12-
Official PHP SDK for [RoxyAPI](https://roxyapi.com): natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, human design bodygraphs, and transit forecasts across Western and Vedic astrology, forecast, human design, Chinese astrology, feng shui, numerology, tarot, biorhythm, I Ching, crystals, dreams, angel numbers, and location geocoding. 209+ endpoints across 14+ domains, one API key, one dependency (Saloon).
12+
Official PHP SDK for [RoxyAPI](https://roxyapi.com): natal charts, daily horoscopes, synastry, Vedic kundli, tarot spreads, human design bodygraphs, and transit forecasts across Western and Vedic astrology, forecast, human design, Chinese astrology, feng shui, Mesoamerican astrology, Vastu, numerology, Kabbalah, tarot, biorhythm, Ayurveda, I Ching, crystals, dreams, angel numbers, and location geocoding. 258+ endpoints across 18+ domains, one API key, one dependency (Saloon).
1313

1414
## Install
1515

lefthook.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,14 @@ pre-push:
2424
codegen-drift:
2525
env:
2626
ROXYAPI_SPEC_FILE: specs/openapi.json
27-
run: node scripts/generate.mjs && git diff --exit-code -- specs/openapi.json src/Generated src/Roxy.php src/Version.php tests/Generated || { echo 'codegen drift: commit the regenerated files'; exit 1; }
27+
run: >-
28+
node scripts/generate.mjs && git diff --exit-code -- specs/openapi.json src/Generated src/Roxy.php src/Version.php tests/Generated
29+
|| { echo 'codegen drift: commit the regenerated files'; exit 1; }
2830
priority: 3
2931
docs-drift:
30-
run: node scripts/sync-docs.mjs && git diff --exit-code -- README.md AGENTS.md || { echo 'docs drift: commit the regenerated README.md/AGENTS.md'; exit 1; }
32+
run: >-
33+
node scripts/sync-docs.mjs && git diff --exit-code -- README.md AGENTS.md
34+
|| { echo 'docs drift: commit the regenerated README.md/AGENTS.md'; exit 1; }
3135
priority: 4
3236
test:
3337
run: vendor/bin/pest

0 commit comments

Comments
 (0)