Skip to content

List documents does not work according to docs #2238

@johndev168

Description

@johndev168

Describe the bug
When requesting r2r to list documents via GET /v3/documents there are a few issues present. According to the docs you can specify a limit in integer of <= 1000 and >0. In the same entry it's noted that it can only be between 1 and 100. This is only a minor thing.
Also, according to the docs, there should be a total number of files in the response. This is missing, too. The property is entirely missing from the response.

To Reproduce
Steps to reproduce the behavior:

  1. Send a simple GET request to the server like mentioned in the docs in order to list the uploaded documents.
  2. Notice that "limit" in docs can be set >= 1 and <=1000 but <=1000 makes no sense since docs mention only values ranging from 1 to 100 are valid.
  3. Read the response, you'll notice that a total file count should be present according to docs. But there is no such property and the total amount is missing.
    Expected behavior
    The docs should be updated to fix the right limits of "limit" property. Also there should be a property "total_entries" in the response.

Desktop (please complete the following information):

Additional context
This is both a typo in the documentation and also a bug where the number of uploaded documents should be sent back which is not the case. I have no way to count the total number of uploaded files because the api won't tell me, though iterating and going through the list in steps of 100 is possible. So it's not a major bug.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions