whatsapp-http-api icon indicating copy to clipboard operation
whatsapp-http-api copied to clipboard

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

Open AliSot2000 opened this issue 7 months ago • 0 comments

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": "<EngineString>"} Object or, since that object doesn't encode anything meaningful, flatten it to the outer engine field being an Engine Enum

AliSot2000 avatar Jul 02 '24 22:07 AliSot2000