Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remaining API endpoints #65

Open
abunashir opened this issue Oct 17, 2017 · 12 comments
Open

Remaining API endpoints #65

abunashir opened this issue Oct 17, 2017 · 12 comments

Comments

@abunashir
Copy link
Member

abunashir commented Oct 17, 2017

App Data:

Do we need to any other action like fetch, create, edit, update or destroy here?
Source: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/app_data.rb

App Relation

Is there anything else on this API endpoint?
Source: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/app_relation.rb

Calendar

Do you need any remove or delete action for this one?
Source: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/calendar.rb

Events

We haven't implement anything on that one yet!

@ronaldtse
Copy link
Contributor

Perhaps @ribose-jeffreylau can clarify?

@ribose-jeffreylau
Copy link
Contributor

@abunashir

App Data:

None of the actions (fetch, create, edit, update or destroy) are needed.
Source: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/app_data.rb

App Relation

Nothing else is needed.
Source: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/app_relation.rb

Calendar

Yes, delete action is needed.
Source: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/calendar.rb

Events

all, fetch, create, update and destroy are needed.

@ribose-jeffreylau
Copy link
Contributor

@PeterTKY will be able to provide API information on Calendar and Events.

@abunashir
Copy link
Member Author

abunashir commented Oct 18, 2017

Thanks, @ribose-jeffreylau! What about the following ones?

Widget

We only have all here, what others might be necessary?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/widget.rb

Stream

We only have all, anything else here?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/stream.rb

Space File

We have all and create there, do we need anything else?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/space_file.rb

Space

We have all, fetch, create and remove, is there any other here?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/space.rb

Settings

We have all and fetch, is there anything else on this one?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/setting.rb

Messages

We have all, create and update there, is there anything else on this one?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/message.rb

Members

We only have all there, is there anything else on this one?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/member.rb

Leaderboard

We only have all there, is there anything else on this one?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/leaderboard.rb

Feed

We only have all there, is there anything else on this one?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/leaderboard.rb

Conversation

We have all, create and remove there, is there any other action?
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/conversation.rb

@ronaldtse
Copy link
Contributor

@abunashir we need full implementation for:

  • Conversation (room CRUD / message CRUD)
  • Space File add version, delete remove
  • Stream fetch with filters

In general the endpoints should support start, length parameters.

@abunashir
Copy link
Member Author

Thanks, @ronaldtse! We already have the support for query params, so when a user provides the key-value pair as query: then that will get appended to the URL (in .all actions), but I think we have to clear that up when we are writing the documentation.

@ronaldtse
Copy link
Contributor

@abunashir in this case should we always provide a default start=0/length=20 so the results can be returned with some pagination?

@abunashir
Copy link
Member Author

@ronaldtse: In some cases, yes, like we are doing here: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/connection.rb#L15 but if the resource provides the complete results then we did not pass anything as default.

@ribose-jeffreylau
Copy link
Contributor

ribose-jeffreylau commented Oct 18, 2017

@abunashir

Widget

For the CLI, widgets don't provide much value. I don't think we need any other actions for now.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/widget.rb

Stream

Nothing else is needed.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/stream.rb

Space File

Need update, add_version (which uploads a new version to the same "file"), destroy.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/space_file.rb

Space

Need update.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/space.rb

Settings

Need update.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/setting.rb

Messages

I also see remove implemented. Nothing else is needed.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/message.rb

Members

Nothing else is needed.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/member.rb

Leaderboard

Nothing else is needed.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/leaderboard.rb

Feed

As a CLI, feed doesn't provide much value, but create and destroy actions do exist.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/feed.rb

Conversation

As @ronaldtse stated, we need create, update, fetch and destroy for both "conversation room" and "conversation message" objects.
Link: https://github.com/riboseinc/ribose-ruby/blob/master/lib/ribose/conversation.rb

Thanks!

@abunashir
Copy link
Member Author

Great, Thanks, @ribose-jeffreylau. I will start implementing those soon :)

@ribose-jeffreylau
Copy link
Contributor

@abunashir We can skip implementation of Feed as it is not really useful for a CLI client.

@abunashir
Copy link
Member Author

Thanks, @ribose-jeffreylau! Btw, Did you have a chance to check the events API?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants