search

riboseinc / ribose-api

API for Ribose
0 stars 0 forks source link

Create API documentation for Space People (CRUD space members) #11

Closed ronaldtse closed 7 years ago

ronaldtse commented 7 years ago

@skalee , would you be able to help us document the Ribose API (which is implemented in https://github.com/riboseinc/ribose-ruby/) for the Space People section, in the Apiary MSON format?

You can find out the details of the API in the gem (and maybe some reverse engineering of our web interface), and @abunashir would also be able to help.

Let me know. Thanks!

skalee commented 7 years ago

@ronaldtse sure.

skalee commented 7 years ago

@ronaldtse Is there any piece of similar documentation for other API sections of this gem I should base on? Or do we start it from scratch?

ribose-jeffreylau commented 7 years ago

@skalee @PeterTKY added the Calendar section, while I converted the Invitation section from the Github wiki to the APIB format, which you can refer to when helping us convert the other sections.

We use the Group directive to group sections.

Build instructions for the APIB files can be found in the README.adoc in this repo.

skalee commented 7 years ago

@ribose-jeffreylau Thanks! I was looking for it in client's repo for some reason. Now it's all clear.

ribose-jeffreylau commented 7 years ago

@skalee

I apologise that I have accidentally implemented this without realizing sooner!

Let me reassign this task to myself... Sorry about that 😅

ronaldtse commented 7 years ago

Thank you @ribose-jeffreylau !

skalee commented 7 years ago

No problem @ribose-jeffreylau, I had little time earlier this week anyway!