partners-api

What problem does it solve?

Prevents misconfiguration and developer confusion when working with the separate Partners API environment by documenting its unique routing, authentication, validation, and documentation differences so integrations behave predictably.

Core Features & Use Cases

• Environment specifics: Clarifies that the Partners service runs on port 8082 and exposes endpoints at the root path (no /api prefix).
• Authentication handling: Describes ExternalToken header lookup via PartnersExternalAuthMiddleware and how controllers bypass JWT guards.
• Validation and docs: Notes the permissive validation pipe for forward compatibility and the separate Swagger instance available at /docs.
• Use case: When adding a new partners endpoint or onboarding an external partner, use these conventions to ensure requests authenticate via ExternalToken, accept extra fields, and are documented under the Partners Swagger.

Quick Start

Use the partners-api skill to explain how to add or modify a partners endpoint that uses ExternalToken authentication, serves on port 8082 with root-level routes, and appears in the separate /docs Swagger.