Skip to content

feat(api): documentar rutas con OpenAPI 3.1 y Swagger - #3

Merged
Grxson merged 2 commits into
mainfrom
feat/platform-openapi-swagger
Nov 7, 2026
Merged

Grxson merged 2 commits into
mainfrom
feat/platform-openapi-swagger

Conversation

@Grxson

@Grxson Grxson commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Resumen

  • Documenta las siete rutas y ocho operaciones actuales desde handlers y DTO HTTP con utoipa 6 / utoipa-axum 0.3; Swagger UI opcional en /docs/.
  • Normaliza errores HTTP, fechas RFC 3339 y errores de PostgreSQL; corrige persistencia JSONB de licencias DEV sin modificar migraciones.
  • CI valida OpenAPI 3.1, compara snapshot generado byte a byte y ejecuta pruebas HTTP reales contra BD aislada.

Validación local (Windows)

  • cargo fmt --all -- --check
  • cargo clippy --workspace --all-targets -- -D warnings
  • cargo test --workspace con TEST_DATABASE_URL en hiqnet_p00_test_20261107
  • openapi-spec-validator 0.9.0 --schema 3.1 openapi/openapi.json
  • python scripts/check_repository.py; tests Python; git diff --check
  • docker build -t hiqnet-platform-api:p01-check .
  • Contenedor P01 temporal contra BD aislada: /health, /ready, /api/v1/plans, /api-docs/openapi.json, /docs/ = 200. Contenedor detenido.

Límites

Sin P02, cambios a 0001_init.sql, tokens o claves reales, tags ni releases. No fusionar automáticamente. Omarchy no verificado. Documentación: docs/02-development/api.md.

Copilot AI balanced review requested due to automatic review settings November 7, 2026 17:24

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@Grxson
Grxson merged commit 548f8fe into main Nov 7, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants