Skip to content

[docs] Document Django Channels WebSocket endpoints #682

@nemesifier

Description

@nemesifier

Document Django Channels WebSocket API

Context: This repository implements Django Channels WebSocket endpoint(s) for batch operations:

  • Batch operation: ws://<host>/ws/radius/batch/<batch_id>/

There is no formal documentation in the docs/ folder describing these endpoints or their message types.

Message Types

  • batch_status_update (e.g. { "status": "completed" } )

Suggestion:
Please create documentation in docs/user/websocket-api.rst (or similar location) covering:

  • The WebSocket endpoint URLs and usage
  • Message types with sample payloads
  • Authentication and authorization requirements
  • Purpose: Improve developer integration experience and maintainability

This is modeled after the suggestion in openwisp-firmware-upgrader.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation related issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions