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

You know about slack-api-ref? #1

Open
dblock opened this issue Mar 1, 2017 · 6 comments
Open

You know about slack-api-ref? #1

dblock opened this issue Mar 1, 2017 · 6 comments

Comments

@dblock
Copy link

dblock commented Mar 1, 2017

Is https://github.com/slack-ruby/slack-api-ref the same? More complete?

@mthjones
Copy link
Member

mthjones commented Mar 6, 2017

Interesting, thanks for the heads up! I wasn't aware of that project.

One issue I noticed in those schemas is a lack of response or object schemas, which are very important for this project to generate deserializable response types.

Perhaps we can coordinate our efforts to allow the schemas to work for both of us.

@dblock
Copy link
Author

dblock commented Mar 6, 2017

I'd take any PRs into slack-api-ref that make sense. That project is used by https://github.com/slack-ruby/slack-ruby-client and possibly others so it's not going away.

@mre
Copy link

mre commented Mar 9, 2017

slack-api-ref is auto-updated by a cronjob whenever there are changes on the API. Also it contains all example responses from the API.

@mthjones maybe you could contribute your schema for the responses to slack-api-ref. It would greatly help to have it all in one place.

Also, did you write the schemas yourself or did you use a tool for that? Can't find any code for that in the project. Would be great to add it to the repo. 😃

@mre
Copy link

mre commented Apr 27, 2017

Any update on this? Would really love to hear, which tool you use to generate the slack-api-ref.

@mthjones
Copy link
Member

@mre Put up the scraper that generates the schemas (it's pretty horrific).

I don't have any time to dedicate to looking at merging the two schema definitions. Happy to take PRs on slack-rs-api that use the slack-ruby schemas though if anyone is interested.

@Mange
Copy link

Mange commented Mar 25, 2018

I looked into those schemas, and it's just like was said: It contains no information about the actual content of messages.

The Ruby client does not even try to emit the fields that are possible, instead dynamically typed "object/hash" mashups are used, where x.foo would look for a "foo" key in the underlying storage. That's how they get away with this.

I raised a question for the official Swagger docs repo from Slack here slackapi/slack-api-specs#7. It might be our best bet...

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

4 participants