Skip to content

Commit

Permalink
mention swagger and api
Browse files Browse the repository at this point in the history
  • Loading branch information
vgarcia007 committed Sep 24, 2024
1 parent aba698e commit a13aa18
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,8 @@ Thus, make sure to wait for your scan to complete, before pressing another butto
#### API
The GUI uses a minimal "API" at the backend, which you can also use from other tooling (e.g., Home Assistant or a control panel near your printer).
To scan, simply call `http://<ContainerIP>:<Port>/scan.php?target=<file|email|image|OCR>`
Also check out the endpoints `list.php`, `download.php`, `active.php`.
Maybe one day an OpenAPI Spec will be included.
To scan, simply call `http://<ContainerIP>:<Port>/api/scanner/scanto/<file|email|image|OCR>`
Also check out the swagger file in the doc directory to see all available endpoints.

## Full Docker Compose Example

Expand Down

0 comments on commit a13aa18

Please sign in to comment.