Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Web API #24

Open
cebarks opened this issue Mar 6, 2021 · 0 comments
Open

Feature: Web API #24

cebarks opened this issue Mar 6, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@cebarks
Copy link
Member

cebarks commented Mar 6, 2021

We need a set of API endpoints for some of the database tables. It should be:

  • protected by some kind of security (basic auth, OAUTH, token, etc)
  • run in-process for the bot, not a separate process
    • in a seperate go routine
  • use json for api requests/respones
    • complicated requests should use json structs in the body, not query params!
  • be configurable with at least the following options:
    • listen path
    • listen port
    • optional https support
    • enable/disable

Endpoints:

  • /api/v0/topics - List all Topics
  • /api/v0/topic/:id - Show topic
  • /api/v0/topic/:id/channels - List all channels belonging to topic
  • /api/v0/topics/:id/channel/:id - Show channel belonging to topic
@cebarks cebarks added the enhancement New feature or request label Mar 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant