Commit e8cc0f47 authored by Joan Pascual Sana's avatar Joan Pascual Sana

Create wiki.md

parent 39ff028c
......@@ -23,4 +23,5 @@
#!docs/README.md
.gitignore
test/__init__.py
\ No newline at end of file
test/__init__.py
wiki.md
\ No newline at end of file
# Wiki
The purpose of this file is to add some additional documentation of how
to use this API client.
* [Test examples](#test-examples)
* [How to upload files](#file-uploads)
* [Asynchronous functions](#asynchronous-functions)
## Test examples
Here some test examples to follow:
* [Get API instance](test/__init__.py)
* [Login](test/test_req_json_api_server_version.py): with your location
account id and password.
* [Test unauthenticated method](test/test_req_json_api_server_version.py):
this test points to `/jsonApiServer/version`, accessible without auth.
* [Test authenticated method](test/test_req_rs_gxs_channels_get_channels_summaries.py):
points to `/rsGxsChannels/getChannelsSummaries`, needed auth.
* Create channel
[with deprecated method](test/test_req_rs_gxs_channels_create_channel.py)
and [v2 method](test/test_req_rs_gxs_channels_create_channel_v2.py).
* [Get channels info](test/test_req_rs_gxs_channels_get_channels_info.py).
* [Add shared directory](test/test_req_rs_files_add_shared_directory.py).
* [Create a post with files](test/test_req_rs_gxs_channels_create_post.py):
this have also an example of how to loop through channel summaries.
## File uploads
For file uploads you have two ways:
1. [Add shared directory](test/test_req_rs_files_add_shared_directory.py)
and then play with `/rsFiles/getSharedDirectories`,
`/rsFiles/setSharedDirectories` and `/rsFiles/addSharedDirectory` to
get the SHA1 generated by RetroShare. Otherwise you can generate your
own SHA1 following the example on the test
[create a post with files](test/test_req_rs_gxs_channels_create_post.py)
2. Add an independent file playing with `/rsFiles/ExtraFileHash` and
`/rsFiles/ExtraFileRemove`.
## Asynchronous functions
Not yet supported, see
https://github.com/OpenAPITools/openapi-generator/issues/3696 .
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment