Skip to main content

External API PM Reconciliation

ItemAPI-Doc statusPM revision statusCurrent alignmentNotes
Source of truthAPI-Doc defines the current public external API contractPM revision mirrors API-Doc in Chinese for contract contentAlignedContract changes must land in API-Doc first
Auth token prefixActive auth example is Authorization: Bearer uak_your_api_keySame active wording is used in the PM revisionAlignedUse uak_... examples consistently
Shared error bodyExternal errors use { code, message, errorKey, traceId } with real HTTP status codesSame shared error body and status semantics are documented in ChineseAligned/external/* final error body remains the external contract
Shared pagination contractCommon envelope fields are page, pageSize, total, totalPages, and hasMoreSame semantics are summarized in ChineseAlignedRoute-specific request naming and item fields remain endpoint-specific
Live endpoint inventory16 live endpoints across 5 controller familiesSame 16 live endpoints are listed under the implemented-now summaryAlignedThe implemented-now summary matches the current controller inventory
Events endpoints4 endpoint pages include success status, request section, response example, error responses, and notes4 Chinese endpoint sections mirror the same contract dataAlignedResponse examples and status codes now track API-Doc
Exhibitors endpoints5 endpoint pages define list, search, search-events, profile, and related-events behavior5 Chinese endpoint sections mirror the same contract dataAlignedexhibitor_id-only profile lookup is preserved while search-events covers the direct company-name-to-events flow
Personnel endpoints3 endpoint pages define list, profile, and related-events behavior3 Chinese endpoint sections mirror the same contract dataAlignedLightweight public personnel shape is preserved
Contacts endpointGET /external/contacts/search uses company-based query input and a contact-style responseChinese endpoint section mirrors the same contract dataAlignedEmail remains intentionally excluded
Profile Matching endpointsCurrent live contract is POST /external/profile-matching/recommendations/events/paged plus GET /external/profile-matching/recommendations/exhibitorsChinese endpoint sections mirror the same live contractAlignedProfile-matching documentation is aligned to the implemented public routes
Intentional differencesEnglish Mintlify prose, navigation, and cross-linksChinese PM prose and PM-facing framingIntentional wording difference onlyThis is not a contract mismatch

Maintenance rule

  1. Update API-Doc first whenever the public contract changes.
  2. Mirror the same contract change into PM 外部 API 接口文档(revision).md.
  3. Refresh this reconciliation artifact only when the synchronization rule itself changes or a new divergence appears.

Review notes

  • PM revision now carries endpoint-level success status codes, request sections, response examples, error responses, and notes for all 15 live endpoints.
  • This artifact now tracks the synchronized state rather than the earlier pre-sync discrepancy snapshot.
  • Future discrepancies should be treated as contract mismatches only when method/path, status code, request fields, response structure, or caller-visible note semantics diverge.