Skip to content

[Documentation] API documentation with OpenAPI/Swagger #5

Description

@OneByJorah

API Documentation Checklist

  • Add FastAPI/OpenAPI schema generation for agent server
  • Add Swagger UI / ReDoc endpoints
  • Document all bot commands
  • Document agent registration API
  • Document agent command API
  • Document SNMP device API
  • Document dashboard WebSocket API
  • Add API versioning strategy
  • Generate markdown docs from OpenAPI spec

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions