slackhq / slack-api-docs

API Docs for Slack.com
https://api.slack.com/
426 stars 85 forks source link

Is this Repo still active? #74

Open prashanthsadasivan opened 7 years ago

prashanthsadasivan commented 7 years ago

I know that the main Elixir Slack client depends on this repository's JSON docs to generate the client. I'm sure there are others as well. But looking at the commit history, this repository hasn't been updated in just about a year, and slack's released a lot of interesting features since then, but the generators can't pick up on those changes!

Will this repository get updated anytime soon?

brianleroux commented 7 years ago

@prashanthsadasivan fwiw, our js client scrapes the web ---which yes is sketchy but def stays up to date! (Usually we update same day.) https://github.com/smallwins/slack

aoberoi commented 7 years ago

I'm sorry to say that you shouldn't expect this repository to be updated along with the documentation at api.slack.com. The repo still exists mainly because we know people already depend on it and don't want to intentionally break anyone.

We are exploring what publishing a machine-readable API spec could offer, and if you have any particular insight or requirements, we're happy to take that feedback.

mre commented 7 years ago

Thanks for the feedback @aoberoi. I guess we all really appreciate it that you take our issues seriously.

Over at slack-ruby/slack-api-ref we're currently struggling with the JSON syntax errors in the example responses of the official Slack API documentation.

For example this response is not valid JSON. There is an extraneous comma at the end of "is_starred": true,. This makes it super hard to auto-generate valid response types for the Slack API methods, which are required for statically typed language (C++, Go, Rust,...).

If you consider a machine-readable spec it would be great to fix that. Also it would be nice to add some type hints for each field, e.g. (string, int, float,...).

morozgrafix commented 7 years ago

@mre just came across your post and got rid of that extra comma in the Slack API docs. https://api.slack.com/methods/im.history Thanks for bringing it up and sorry it took so long to get that fixed