devlikeapro / waha

WAHA - WhatsApp HTTP API (REST API) that you can configure in a click!
https://waha.devlike.pro/
Apache License 2.0
819 stars 249 forks source link

[Swagger] - GET /api/sessions/{session} has missing documentation (engine enum) #410

Open AliSot2000 opened 5 days ago

AliSot2000 commented 5 days ago

Describe the bug According to the schema the engine field of the SessionInfo Model should be an object That's technically not wrong but the Documentation could be complete and indicate it is a another object like {"engine": <EngineString>}

Version

{
  "version": "2024.6.8",
  "engine": "NOWEB",
  "tier": "PLUS",
  "browser": "/usr/bin/chromium"
}

To Reproduce Steps to reproduce the behavior:

  1. Start an Instance
  2. Go to the API Docs
  3. Create a Session
  4. Check the /api/sessions/{session} Endpoint
  5. Compare the Scheme to the returned Value when you get the session information

Expected behavior Either provide correct Documentation -> So another Model for the {"engine": ""} Object or, since that object doesn't encode anything meaningful, flatten it to the outer engine field being an Engine Enum