/press endpoint documentation

[brgerig]

Is there any documentation on what the /press endpoint is expecting? POST or GET, Content-type, data to send? Admin password as bearer token, correct? I apologize if I've missed it somewhere, but if it isn't there could it be added? Thanks!

[arnegiacomo]

Well no not really right now. "The code is the documentation"

I'm unsure how easy it is, but we could probably generate an openapi spec on build and upload it to the docs? Would that be useful if feasible?

[arnegiacomo]

I was prepping dinner, so please excuse my Norwegian directness in the previous reply.

So basically it's a POST with a form body (application/x-www-form-urlencoded). The password goes in the body, not in a bearer token (We talked about a bearer token in #330, but #337 ended up taking the password in the form body, the same way the sign-in page does ):

curl -X POST http://.local:8080/press -d button=A -d password=

• button - A, B, C or D, the same as the panel's buttons: mode, names, rotate and style
• password - only needed if the admin page has sign-in enabled
• External e-ink panel has to be switched on under Frame, otherwise /press should return a 404

Responses: 204 on success, 400 for an unknown input, 401 for a wrong password, and 429 after too many attempts. examples/inky/main.py is a working client.

About OpenAPI: I'm walking that back. The server is plain http.server, so I don't think we can easily generate a spec, and /press is anyways the only endpoint clients post to. I could however add it to the external panel docs instead?

[brgerig]

Oh, no problem, no offense taken!

Panel docs makes sense to me. Thanks for the rundown of the parameters!

[arnegiacomo]

Sweet, I'll add improving panel docs to my list 👌

[arnegiacomo]

Done! I've kept it short and simple, we can ofc revisit this in the future if we get more relevant developer docs. Thanks for bringing this up! I'll go ahead and close this discussion :-)

6347348