Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 1.41 KB

README.md

File metadata and controls

17 lines (13 loc) · 1.41 KB
Raw

Simple REST API with Quart and OpenAI Chat platform integration.

This Python code creates a REST API using the Quart micro-framework. It communicates with the OpenAI Chat platform.

The API has several endpoints available for performing operations on a per-user in-memory todo list.

Endpoints:

  • POST /todos/string:username - allows a user to add a todo. The request body must contain a JSON object with the 'todo' field.
  • GET /todos/string:username - returns all todos for the specified user. An optional query parameter "completed" specifies whether to return only completed todos (if completed=True) or only the ones that are not completed (if completed=False).
  • GET /todos/string:username/int:todo_idx - returns a single todo item for the specified user and index.
  • PUT /todos/string:username/int:todo_idx - allows updating the title of a todo. The request body must contain a JSON object with the 'title' field.
  • PATCH /todos/string:username/int:todo_idx/complete - allows marking a todo as "completed"
  • DELETE /todos/string:username/int:todo_idx - allows deleting a todo.

Details

The code includes utility functions that check for the presence of an "Authorization" header with a specific token. The other two utility functions are for static files serving. plugin_manifest() returns an OpenAPI JSON description of the plugin, while plugin_logo() returns a logo image rendered.

This app runs on port 5002 of the local machine.