Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api doc link broken #626

Open
WolfgangFahl opened this issue Aug 24, 2024 · 0 comments
Open

api doc link broken #626

WolfgangFahl opened this issue Aug 24, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@WolfgangFahl
Copy link

WolfgangFahl commented Aug 24, 2024

The link in https://papermerge.com/pages/rest-api
https://docs.papermerge.io/REST%20API/index.html

is broken. The result should be more like below:

Papermerge DMS API Endpoints

Users

Method Endpoint Description
GET /users/me Get Current User
GET /users/ Get Users
POST /users/ Create User
DELETE /users/{user_id} Delete User
PATCH /users/{user_id} Update User

Nodes

Method Endpoint Description
GET /nodes/ Get Nodes
POST /nodes/ Create Node
DELETE /nodes/ Delete Nodes
GET /nodes/{parent_id} Get Node
PATCH /nodes/{node_id} Update Node
POST /nodes/move Move Nodes
POST /nodes/{node_id}/tags Assign Node Tags
PATCH /nodes/{node_id}/tags Update Node Tags
DELETE /nodes/{node_id}/tags Delete Node Tags

Folders

Method Endpoint Description
GET /folders/{folder_id} Get Node

Documents

Method Endpoint Description
GET /documents/{document_id} Get Document Details
POST /documents/{document_id}/upload Upload File

Document Versions

Method Endpoint Description
GET /document-versions/{document_version_id}/download Download Document Version

Pages

Method Endpoint Description
GET /pages/{page_id}/svg Get Page Svg Url
GET /pages/{page_id}/jpg Get Page Jpg Url
POST /pages/ Apply Page Operations
POST /pages/move Move Pages
POST /pages/extract Extract Pages

Thumbnails

Method Endpoint Description
GET /thumbnails/{document_id} Retrieve Document Thumbnail

Tags

Method Endpoint Description
GET /tags/ Retrieve Tags
POST /tags/ Create Tag
DELETE /tags/{tag_id} Delete Tag
PATCH /tags/{tag_id} Update Tag

Tasks

Method Endpoint Description
POST /tasks/ocr Start OCR

OCR Languages

Method Endpoint Description
GET /ocr-languages/ Get OCR Langs

Version

Method Endpoint Description
GET /version/ Get Version

Search

Method Endpoint Description
GET /search/ Search
@WolfgangFahl WolfgangFahl added the bug Something isn't working label Aug 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants