Documentación pública · v1.0.0

09 · Publicación

MSD-09-PUB · Publicación

Una plataforma para desarrolladores solo está completa cuando puede distribuirse, instalarse y mantenerse de forma oficial.

Toda la operación. Una sola plataforma.


Objetivo del capítulo

Definir el proceso oficial de publicación, distribución y mantenimiento de los artefactos para desarrolladores de Roustix: documentación, OpenAPI, SDK, CLI y colecciones.

MSD-09 establece el ciclo de vida del ecosistema de desarrollo, garantizando que todos los componentes evolucionen de forma sincronizada con MAG y con cada versión de la plataforma.


1 · Filosofía

Publicar no es subir archivos.

Es distribuir un ecosistema coherente.

Cada versión de Roustix debe publicar simultáneamente:

Código / MAG
      │
      ▼
   OpenAPI
      │
      ▼
     SDK
      │
      ▼
     CLI
      │
      ▼
Colecciones
      │
      ▼
Developer Portal

Toda la documentación debe representar exactamente el estado de la plataforma.


2 · Artefactos oficiales

Cada versión publica los siguientes componentes:

ArtefactoEstado documentalEstado distribución
OpenAPI 3.1✅ Oficial🟢 openapi.v1.yaml · /api/v1/openapi.json
SDK Python✅ Estrategia MSD-04📋 PyPI pendiente
SDK JavaScript✅ Estrategia MSD-04📋 npm pendiente
SDK PHP✅ Estrategia MSD-04📋 Packagist pendiente
Roustix CLI✅ Estrategia MSD-05📋 PyPI pendiente
Colección Postman✅ Snapshot v1🟢 docs/api/collections/
Colección Insomnia✅ Snapshot v1🟢 docs/api/collections/
Developer Portal✅ MSD-02🟡 /msd/ · 📋 developer.roustix.app

Todos siguen el mismo número de versión del ecosistema cuando se publiquen paquetes (1.x ↔ MAG v1).


3 · Plataformas de publicación

ArtefactoPlataforma
SDK PythonPyPI (roustix)
SDK JavaScriptnpm (@roustix/sdk)
SDK PHPPackagist (roustix/sdk)
CLIPyPI (roustix-cli)
OpenAPIRepositorio + GET /api/v1/openapi.json
Coleccionesdocs/api/collections/ + Portal
DocumentaciónDeveloper Portal · Roustix Docs

4 · Versionado

Todos los componentes siguen el contrato definido en MAG-07:

ComponenteVersionado
APIMAG v1
OpenAPIv1 (info.version: 1.0.0)
SDK1.x
CLI1.x
Coleccionesv1 (Roustix API v1)
MSD (docs)v1.0.0

No pueden existir SDK o CLI oficiales incompatibles con la versión vigente de MAG.


5 · Flujo de publicación

Nueva versión Roustix
          │
          ▼
   Actualizar MAG
          │
          ▼
   Generar OpenAPI
          │
          ▼
    Generar SDK
          │
          ▼
    Generar CLI
          │
          ▼
 Generar colecciones
          │
          ▼
Publicar Developer Portal
          │
          ▼
   Release oficial

El flujo garantiza que todos los artefactos permanezcan sincronizados.


6 · Integración continua

La publicación forma parte del pipeline CI/CD (objetivo operativo MSD v1.0):

Cada release ejecuta automáticamente:

  1. validación OpenAPI (Spectral · Prism)
  2. pruebas del SDK
  3. pruebas de la CLI
  4. generación de colecciones
  5. despliegue del Portal
  6. publicación de documentación

Solo si todas las verificaciones son exitosas se realiza la publicación.

EtapaHerramienta
Lint OpenAPISpectral
Contract testsPrism · sandbox
SDK testspytest · jest · phpunit
Coleccionesopenapi2postmanv2
Portaldeploy estático / CDN
Estado: pipeline documentado · automatización en roadmap post MSD v1.0 doc.

7 · Changelog

Cada publicación incorpora un historial de cambios.

Ejemplo:

Roustix SDK 1.2.0

+ Nuevo módulo Inventory
+ Nuevos endpoints Work Orders
+ Correcciones CLI
+ Mejoras OpenAPI

Los cambios incompatibles solo aparecen en nuevas versiones mayores (MAG v2 · SDK 2.x).

Fuentes oficiales:


8 · Compatibilidad

Todos los artefactos mantienen compatibilidad con la misma versión de la API:

MAG v1
│
├── OpenAPI v1
├── SDK 1.x
├── CLI 1.x
└── Colecciones v1

No se mezclan versiones mayores.


9 · Distribución

Los desarrolladores disponen de un único punto de acceso:

https://developer.roustix.app

Local (transitorio): http://127.0.0.1:5000/msd/

Desde el Portal pueden:

  • consultar la documentación
  • descargar OpenAPI
  • instalar SDK
  • instalar la CLI
  • descargar colecciones
  • acceder al Sandbox
  • revisar el changelog

El Portal es el centro del ecosistema para desarrolladores.

MSD-02 · Developer Portal


10 · Buenas prácticas

#Regla
1Publicar todos los artefactos conjuntamente
2Mantener el mismo versionado entre componentes
3No distribuir SDK generados manualmente
4Validar OpenAPI antes de publicar
5Actualizar la documentación en cada versión
6Mantener un changelog completo
7Automatizar el proceso mediante CI/CD

11 · Roadmap

Evolución prevista del ecosistema:

  • publicación automática en GitHub Releases
  • firma digital de paquetes
  • Docker oficial para el Sandbox
  • cliente MCP para IA y agentes
  • SDK para Go, Java y C#
  • Marketplace de integraciones
  • registro de plugins oficiales

Filosofía del capítulo

Una plataforma moderna no termina en su API. Su verdadero valor aparece cuando cualquier desarrollador puede descubrirla, instalar sus herramientas, integrarlas y mantenerlas con confianza.

MSD-09 cierra el ecosistema para desarrolladores de Roustix, unificando documentación, OpenAPI, SDK, CLI, Sandbox y Portal bajo un proceso de publicación coherente, automatizado y versionado.


MSD v1.0 · Índice completo

CódigoCapítuloEstado
MSD-01Filosofía del ecosistema
MSD-02Developer Portal
MSD-03OpenAPI 3.1
MSD-04SDK oficiales
MSD-05CLI
MSD-06Sandbox y API Explorer
MSD-07Quick Start
MSD-08Colecciones Postman e Insomnia
MSD-09Publicación