[Docs] [Minor] Tweak `get_` & `delete_document` method signature to take both type `int` or `str`

Description

Documents Documentation Page (#get-one-document) suggests using int, while the current implementation requires str. Same with delete_document and delete_documents.

Solution

Adjust the method signature parameter or documentation.

Currently, the str type is required in (according to docs):

• Java
• Go
• Rust

The int type is passed in:

• JavaScript
• PHP
• Ruby
• Swift
• Dart

Fork with Tweak

If it will be concluded that it’s best to tweak the method signature, then the fork is here (PR Here). Else, the docs can be updated to string parameters for these methods.

Images

Cheers!

[sanders41]

@alallema I didn’t consider taking both options. Since it works both ways maybe updating the type to take both would be an option. Then there would be no need for the user to convert an int to a str to prevent a type error. It gets converted to a string in the methods when putting it into the URL already so it would be one less step for the end user.

The exception would be if there is anywhere the parameter is added to a dict and passed in the request body instead of the URL, but I can’t think of anywhere currently where the id is passed as a parameter and added to a dict

[bidoubiwa]

(Hey @Luzkan, completely unrelated but what are you using as a tool to darken your views?)