Skip to content

Feat: expand commerce api catalog#30

Merged
wcole1-godaddy merged 13 commits into
godaddy:mainfrom
pbennett1-godaddy:feat/expand-commerce-api-catalog
May 14, 2026
Merged

Feat: expand commerce api catalog#30
wcole1-godaddy merged 13 commits into
godaddy:mainfrom
pbennett1-godaddy:feat/expand-commerce-api-catalog

Conversation

@pbennett1-godaddy
Copy link
Copy Markdown
Collaborator

@pbennett1-godaddy pbennett1-godaddy commented Apr 27, 2026

Description

Expand commerce API catalog with full $ref resolution and agent-friendly output.

Grows the catalog from 9 → 20 domains (94 → 189 endpoints) by pulling all commerce specifications from gdcorp-platform. All $ref references (local #/, relative ./, and external https://)
are now fully resolved — catalog JSON files are completely self-contained with zero dangling refs.

Key Changes

Catalog generator (scripts/generate-api-catalog.ts)

  • Replaced ~450 lines of custom $ref resolution with @apidevtools/json-schema-ref-parser (~55 lines)
  • Custom resolvers handle https://schemas.api.godaddy.com/... URLs and missing common-types submodule paths (flat and nested ref patterns)
  • Added GraphQL-only version directory support (e.g., taxes with v2/schemas/graphql/schema.graphql)
  • Fixed operationId generation: collapse __ runs and strip trailing _

api describe command (src/cli/commands/api.ts)

  • Added schema summarization — 100% of endpoints now fit within 16KB inline (was 67%)
  • Smart type labels: object{owner, channelId, storeId, ...}, array<object{id, name, ...}>, enum(active, inactive)
  • Conditional schema_detail hint only when endpoint has genuinely nested object/array types
  • Added --method/-m option to distinguish endpoints sharing the same path

Catalog

Domain Title Endpoints
bulk-operations Bulk Operations API 26
businesses Commerce Business API 8
catalog-products Catalog GraphQL API 1
channels Channels API 8
chargebacks Chargeback Management 10
customer-profiles Customers API 9
fulfillments Fulfillment Service 3
location-addresses Addresses API 2
metafields Metafields API 12
onboarding Commerce Onboarding API 5
orders Order Service 15
payment-requests Payment Requests API 5
payments Payments API 43
price-adjustments GoDaddy Price Adjustment API 10
recommendations GoDaddy Recommendation API 1
shipping Shipping Service 7
stores Commerce Store API 8
subscriptions Commerce Subscription API 8
taxes Tax GraphQL API 1
transactions Transactions API 7

20 domains · 189 endpoints · 0 unresolved $refs · 12.2 MB total

Comment thread scripts/generate-api-catalog.ts Fixed
Comment thread scripts/generate-api-catalog.ts Fixed
@wcole1-godaddy wcole1-godaddy merged commit 02812ee into godaddy:main May 14, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants