Skip to content

[TECH] Review OpenAPI documentation approach #124

@spydmobile

Description

@spydmobile

Context

swagger-jsdoc@6.2.8 is unmaintained (last update Jan 2023) and pulls deprecated dependencies:

  • glob@7.1.6
  • lodash.mergewith
  • swagger-parser@10.0.3z-schemalodash.get, lodash.isequal

These are not security issues, just deprecation warnings. The packages work fine.

Current State

  • 27 @openapi annotations across 6 route files
  • Serves interactive docs at /api/docs
  • Serves raw spec at /api/openapi.json

Options to Evaluate

  1. Keep as-is - Accept deprecation warnings, they're harmless
  2. Manual spec + swagger-ui-express only - Extract annotations to standalone openapi.yaml, drop swagger-jsdoc
  3. Drop interactive docs entirely - Export static spec at build time, let consumers use their own tools
  4. Alternative library - If a maintained lightweight alternative emerges

Decision Needed

  • Is interactive API documentation actually used/valued?
  • Worth the migration effort to eliminate warnings?

Related

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions