Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

July 2019 OpenAPI 2.0 spec update #23

Merged
merged 3 commits into from
Jul 17, 2019
Merged

July 2019 OpenAPI 2.0 spec update #23

merged 3 commits into from
Jul 17, 2019

Conversation

episod
Copy link
Contributor

@episod episod commented Jul 17, 2019

Web API specifications changelog

July 2019

We've finally made some updates after a long dormant period. Thanks for bearing with us.

Our specifications are programmatically generated from a collection of internal metadata and JSON Schema. As schemas improve or made more correct, the OpenAPI spec evolves. We try to incorporate reported issues in each release.

  • Brought OpenAPI 2.0 specification up to date with most of our internal metadata and JSON schema systems.
    • Because OpenAPI 2.0 uses a subset (and sometimes a superset) of JSON Schema, some schema definitions are modified in translation and not as expressive as reality. In particular, expressing the oneOf instruction is difficult and we replace this nuance with the generic items.
    • Many of our schemas are improved and no longer require copious use of additionalProperties to be described.
  • Removed rtm.start from the method catalog. Its response varies and we strongly recommend developers to use rtm.connect instead.
  • Removed some of the search.* methods from the catalog due to varied responses that cannot yet pass validation. We'll add these back in the next release.
  • Added a bare bones definitions/blocks schema. We'd like to provide finer grained schema for Block Kit in the future.
  • 132 methods now have well-defined response schema.

…available. Removes rtm.start from definition (use rtm.connect) and sets a bare minimum blocks schema until we generate a more formal one. search methods remain a little unstable and will make a resolved appearance soon.
@episod episod marked this pull request as ready for review July 17, 2019 21:12
@episod
Copy link
Contributor Author

episod commented Jul 17, 2019

Now in sync with canonical location at api.slack.com/specs/openapi/v2/slack_web.json

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

Successfully merging this pull request may close these issues.

1 participant