Major: Slack archived the JSON Schema repo

[damienalexandre]

As the title says; the official @slackapi JSON Schema is officially dead: https://github.com/slackapi/slack-api-specs

It's a shame. It was never really up to date, and it's never gonna be. That's why we have to build this huge patch for missing parameters, methods, etc: https://github.com/jolicode/slack-php-api/blob/main/resources/slack-openapi-sorted.patch

I think that on the long run this Slack PHP API Client should not rely on the deprecated spec anymore.

We need to find another way. All we need is a up to date OpenAPI Schema. Maybe we should build it.

• Scrape https://docs.slack.dev/
• Extract from https://github.com/slackapi/python-slack-sdk which is the most up to date client
• Any other idea?

Also, someone discovered a JSON Schema for Block Kit hidden in some tools: https://gist.github.com/renatorib/1fb1a9bd71435b41bee602d15bc56899

Let's also ping some dev advocate here: @mwbrooks @wongjas

[mwbrooks]

Hi @damienalexandre 👋🏻

I know the Slack DevRel team feels your frustration. I believe they were talking about the OpenAPI Schema in March, so I'll share this issue internally with them!

I wonder if your project can leverage some of what the Bolt for Java project uses 🤔 The project has some scripts to generate the type definitions of the Slack API and it works well to keep things update-date. You can find the raw API Responses on the repo as well. Downstream, Bolt for Python and JavaScript use similar scripts.

Tagging @WilliamBergamin because he may be interested in your problem as well!

[dontgitit]

In case this is still relevant — I built a generator that produces an OpenAPI 3.1 spec by parsing the TypeScript AST of the official Node SDK (@slack/web-api, @slack/bolt, @slack/types) using ts-morph.

It currently maps 250+ Web API endpoints and 130+ Events/Actions/Shortcuts. A weekly GitHub Action keeps it in sync with the latest SDK releases.

Repo: https://github.com/connectstrata/slack-openapi-generator

The spec file: slack-openapi-spec.json

[damienalexandre]

Hello! 👋 This is great news - next step will be to test this spec to see if it can be used in replacement of what we have right now without too much BC break for end users (operation names, DTO names, etc).

Thanks a lot for letting us know!

[dontgitit]

For sure - looking forward to hearing how it goes!