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

Commit

Permalink
Merge pull request #23 from slackapi/july_2019_update
Browse files Browse the repository at this point in the history
July 2019 OpenAPI 2.0 spec update
  • Loading branch information
episod committed Jul 17, 2019
2 parents fbfd292 + 6c7e787 commit 9fb2cf2
Show file tree
Hide file tree
Showing 3 changed files with 6,968 additions and 4,693 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,11 @@ We use a combination of internal metadata, custom scripting, and old fashioned w

### Pull requests

Because our specifications are _artifacts_ of an incredible machine, we cannot accept pull requests for this repo. Please file issues with suggestions or bugs with the spec itself. Feedback about the APIs or features the specs describe should be directed to Slack's [developer support team](mailto:feedback@slack.com).
Because our specifications are _artifacts_ of an incredible machine, we cannot accept pull requests for this repo. Please file issues with suggestions or bugs with the spec itself. Feedback about the APIs or features the specs describe should be directed to Slack's [developer support team](mailto:feedback@slack.com).


## Recent changes

Now we'll recount the major changes found in each new release of our specifications.

* [Web API specifications changelog](web-api/CHANGELOG.md)
15 changes: 15 additions & 0 deletions web-api/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 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`](https://api.slack.com/methods/rtm.start) from the method catalog. Its response varies and we strongly recommend developers to use [`rtm.connect`](https://api.slack.com/methods/rtm.start) 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](https://api.slack.com/block-kit) in the future.
* 132 methods now have well-defined response schema.

0 comments on commit 9fb2cf2

Please sign in to comment.