gnh1201/paperless
1
0
Fork 0
mirror of https://codeberg.org/SeedDMS/paperless synced 2025-02-06 06:55:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

better documentation

Browse Source
This commit is contained in:
Uwe Steinmann 2023-03-30 08:28:23 +02:00
parent 210e8a04a9
commit 72cc22e474
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
tests/README.md
View File

@ -1,10 +1,17 @@
Create a file credentials and define AUTH and URL in it.
URL is the base url of the restapi service. AUTH are the credentials
as pass in http header Authorization. It can be ab basic authentication,
a papeerless or a regular SeedDMS token.
# Testing the API
This scripts can be used to test almost all endpoints of the
paperless-ngx API.
In order to use them, create a file `credentials` and define `AUTH` and
`URL` in it. `URL` is the base url of the restapi service. `AUTH` are the
credentials passed in the http header `Authorization`. It can be a basic
authentication, a paperless token or a regular SeedDMS key.
Example:
URL="http://my.seeddms.org/restapi/index.php"
AUTH="my api key"
AUTH="my seeddms api key"
#AUTH="Token <paperless token>"
#AUTH="Basic <credentials>"