drive-apig
v2.4.2

OpenAPI index

Each service spec lives under docs/site/openapi/<service>.yaml and is copied to /openapi/<service>.yaml during yarn build.

OpenAPI covers the HTTP-shaped contract. When a Lambda is SQS-driven in deployed environments but mounted over HTTP for local replay, the operation remains documented and carries:

yaml
x-drive-deployment: local-test-http
x-drive-trigger:
  - sqs

Specs

ServiceOperationsLocal worker harnessesSpecInteractive
ads10/openapi/ads.yamlads API
autograb100/openapi/autograb.yamlautograb API
cachewarm20/openapi/cachewarm.yamlcachewarm API
canbus20/openapi/canbus.yamlcanbus API
cfs30/openapi/cfs.yamlcfs API
cloudflare10/openapi/cloudflare.yamlcloudflare API
cmstosocial00/openapi/cmstosocial.yamlservice page
geo20/openapi/geo.yamlgeo API
leads218/openapi/leads.yamlleads API
marketing71/openapi/marketing.yamlmarketing API
marketplace80/openapi/marketplace.yamlmarketplace API
ml10/openapi/ml.yamlml API
oly10/openapi/oly.yamloly API
purge60/openapi/purge.yamlpurge API
root10/openapi/root.yamlroot API
social40/openapi/social.yamlsocial API
syndication40/openapi/syndication.yamlsyndication API
udp10/openapi/udp.yamludp API

Validation gates

yarn validate:openapi fails when it finds:

  • a serverless.yml HTTP operation missing from OpenAPI;
  • an OpenAPI operation not declared in serverless.yml;
  • a local-only worker harness not explicitly marked x-drive-deployment: local-test-http;
  • path parameters like {stockId} not declared as in: path;
  • mutating operations (POST, PUT, PATCH) without a request body.

Authoring rules

  • Use ApiKeyAuth globally for API-key capable services, then override an operation with security: [] when private: false.
  • Do not document handler-only methods as deployed routes unless API Gateway mounts them. Example: commentCount parses POST in code, but only GET is mounted in services/social/serverless.yml.
  • Keep worker semantics in service pages as well as OpenAPI metadata. Interactive Scalar shows the local harness shape, not the full queue topology.
Esc
Esc Close