Document api endpoints

[sam57719]

Basic:

Create readme that must be updated every time a new endpoint is created.

Simple:

Alternatively, we could add all existing endpoints and new endpoints to the fastapi webserver, meaning they would show up in the swagger docs. However, this goes against the nice plugin architecture we have.

Experimental:

I will also investigate dynamically creating the swagger docs based on the plugin definitions. This would require each plugin to define a request and response model (which could get passed through into fastapi). Would require the http decorator issue.

[sam57719]

Experimental
https://stackoverflow.com/a/73292280

[sjefferson99]

I would like autogenerated swagger, so option 3 sounds like a good one to explore. Might need option 1 for now, just in case we never get 3 and end up with a mammoth docs task.

[sam57719]

Option 1 will be done, and will create a branch for my experimental option 3 (I think it's possible)

[sam57719]

This issue will be used for the basic version - manual documentation