Skip to main content

​
Criterio

  • Total de operaciones en el spec de Yampi: se cuentan todos los métodos HTTP (GET, POST, PATCH, PUT, DELETE) definidos en yampi/swagger/paths/index.yml y sus $ref (p. ej. un path con get y post cuenta como 2 operaciones).
  • Documentadas: operaciones que tienen una página MDX en esta docs con openapi: 'METHOD /path' y contenido (descripción, parámetros y/o ejemplo de solicitud).

​
Cálculo

El archivo paths/index.yml define 167 operaciones (líneas con get:, post:, patch:, put:, delete: a nivel de path). Las páginas de referencia cubren todas las operaciones del spec con una página MDX (openapi, descripción y ejemplo cURL). Por tanto: Completitud = 167 / 167 = 100%

​
Desglose

GrupoPáginas docNotas
Platform18Accounts, Account Users, Agent Bots, Users
Application147+Cuenta, Contacts, Conversations, Messages, Inboxes, Inbox Members, Teams, Team Members, Webhooks, Agent Bots, Agents, Custom Filters, Automation Rules, Canned Responses, Custom Attributes, Integrations, Portals, Reports v2, Treasury, Properties, Companies, Opportunities, Contracts, Captain, SLA, SAML, Reporting
Client13Inbox, Contacts, Conversations, Messages (API pública)
Others2CSAT Survey
Todas las operaciones tienen página propia. El playground de Mintlify (../yampi/swagger/index.yml) sigue disponible para probar método, path, parámetros y esquemas.

​
Validación docs vs spec (codebase Yampi)

Se cruzó la documentación con yampi/swagger/paths/index.yml y los $ref (p. ej. application/contacts/crud.yml, application/portal/).
  • Contactos update: El spec usa PUT en contacts/crud.yml; la doc ya estaba correcta.
  • Portals: El spec solo define POST para portals/{id}/categories y portals/{id}/articles (crear categoría/artículo). Las páginas se corrigieron de “List” (GET) a “Create” (POST). Para portals/{id} el spec solo tiene PATCH (update); la página “Get Portal” (GET) se mantiene con una nota por si la API expone GET.
  • Inboxes: En el spec, show y create usan paths con barra final (inboxes/{id}/, inboxes/). La API puede aceptar con o sin barra; los ejemplos en doc usan sin barra.
  • Reports v2: reports/conversations/ (por agente) tiene barra final en el spec; la doc ya la tenía.
  • Páginas de ejemplo: Las 4 páginas en api-reference/endpoint/* (plants) referencian un OpenAPI de ejemplo, no el de Yampi; no cuentan para el 167.

​
Mantenimiento

Si se añaden nuevas operaciones al spec en paths/index.yml:
  1. Crear un MDX con openapi: 'METHOD /path', descripción breve, ParamField y RequestExample.
  2. Incluir la página en docs.json y en el índice correspondiente (application.mdx, platform.mdx, etc.).
El spec completo está en el repositorio yampi: swagger/index.yml y swagger/paths/index.yml. Cualquier nueva operación añadida allí puede documentarse siguiendo el mismo patrón de los MDX existentes.