Skip to content

p0t4t0sandwich/bee-name-generator

Repository files navigation

bee-name-generator

Description

A bee-themed name generator for various uses.

Discord Bot Usage

Command List

Command Description Parameters Admin Only
/bee_name get Get a bee name None false
/bee_name upload Upload a bee name name: string true
/bee_name suggestion submit Submit a bee name suggestion name: string false
/bee_name suggestion get Get bee name suggestions None true

API Usage

I'm running this api myself here: https://api.sperrer.ca/api/v1/bee-name-generator

Get a bee name

GET /name

JSON response:

{
  "name": "beeatrice"
}

Upload a bee name (Authentication Required)

URL encoded query parameters:

POST /name/:name

JSON body:

POST /name

{
  "name": "beeatrice"
}

JSON response:

{
  "name": "beeatrice"
}

Submit a bee name

URL encoded query parameters:

POST /suggestion/:name

JSON body:

POST /suggestion

{
  "name": "beeatrice"
}

JSON response:

{
  "name": "beeatrice"
}

Get bee name suggestions (Authentication Required)

URL encoded query parameters:

GET /suggestion/:amount

JSON body:

GET /suggestion

{
  "amount": 3
}

JSON response:

{
  "suggestions": [
    "beeatrice",
    "beeatrix",
    "beethany"
  ]
}

Accept a bee name suggestion (Authentication Required)

URL encoded query parameters:

PUT /suggestion/:name

JSON body:

PUT /suggestion

{
  "name": "beeatrice"
}

JSON response:

{
  "name": "beeatrice"
}

Reject a bee name suggestion (Authentication Required)

URL encoded query parameters:

DELETE /suggestion/:name

JSON body:

DELETE /suggestion

{
  "name": "beeatrice"
}

JSON response:

{
  "name": "beeatrice"
}

About

A bee-themed name generator for various uses

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published