search

riboseinc / ribose-api

API for Ribose
0 stars 0 forks source link

Migrate spaces API docs from wiki #43

Closed skalee closed 6 years ago

skalee commented 6 years ago

@ribose-jeffreylau There's space object definition in datatypes section, however it lacks many attributes. Should I enhance and reuse it? Or maybe it's a totally different thing?

Fixes #4.

ribose-jeffreylau commented 6 years ago

@skalee

Good question.

The Space definition mentioned is only used in the GET /app_data request. It is a simplified version of the full serialization, so this Space should probably be renamed to something like SimpleSpace.

On the other hand, the file sections/general.apib actually already covers GET /spaces with the full list of attributes. We can perhaps extract that list as the Space datatype, along with the above SimpleSpace rename.

skalee commented 6 years ago

All the wiki content on spaces has been migrated. However, the Space object contains more, not yet documented attributes, which purpose I am not sure of. Furthermore, I believe there are more CRUD actions which are not documented yet.

skalee commented 6 years ago

Added all CRUD actions and example responses from ribose-ruby. However, a first issue from above comment remains current.

skalee commented 6 years ago

It's my first blueprint for Ribose RESTful API, so it probably requires review.

ribose-jeffreylau commented 6 years ago

Undocumented attributes aren't that important for now, hence I've omitted them.

skalee commented 6 years ago

Fixed according to @ribose-jeffreylau suggestions, merging…