Arksine / moonraker

Web API Server for Klipper
https://moonraker.readthedocs.io
GNU General Public License v3.0
1.02k stars 392 forks source link

Docs/davidzwa fix docs remote api #833

Closed davidzwa closed 2 months ago

davidzwa commented 3 months ago

Motivation

I have been implementing a Typescript client from the Remote API documentation. In some cases I failed to do so because of:

Changes

These are some tweaks to the documentation:

Tests

I have tested all URL changes. The changes work, whereas the original URLs did not (404 response on Moonraker API).

Final remarks

Should not be hard to review!

davidzwa commented 3 months ago

@Arksine Im eager to hear your response!

Arksine commented 3 months ago

Thanks. While the changes look correct, I'm actually in the process of rewriting the entire API documentation, with full schemas and corrected responses. That said, its a long process and I don't know when it will be ready to merge. At the moment I have very little free time to complete it.

davidzwa commented 3 months ago

No problem. Shall we merge this PR and then I help out with the new docs?

Arksine commented 2 months ago

Thanks. After giving this some thought, I do think its worth merging this now and dealing with the merge conflicts on my local rework branch.