|
| 1 | +# diffbot-openapi-spec |
| 2 | + |
| 3 | +A community-managed OpenAPI spec for the (excellent) |
| 4 | +[Diffbot](https://www.diffbot.com/) [API](https://docs.diffbot.com/). |
| 5 | + |
| 6 | +Unfortunately, Diffbot does not appear to publish a public OpenAPI |
| 7 | +spec. However, with a little coaxing, it's possible to extract a |
| 8 | +(generally) OpenAPI spec-shaped object from [its documentation |
| 9 | +platform](https://docs.diffbot.com/). (The curious can check the |
| 10 | +Makefile to see how this is done.) This project simply pulls down that |
| 11 | +OpenAPI-shaped object, massages it into compliance with [v3.0.x of the |
| 12 | +OpenAPI spec](https://spec.openapis.org/oas/v3.0.3.html), and makes |
| 13 | +releases available for general download. |
| 14 | + |
| 15 | +At this time, the author only requires the extract |
| 16 | +endpoints. Therefore, only the extract endpoints are currently |
| 17 | +supported. However, the process to add more endpoints is described in |
| 18 | +the Makefile, and all PRs are welcome. |
| 19 | + |
| 20 | +Naturally, if at any point Diffbot should release an OpenAPI spec |
| 21 | +publicly, users should immediately prefer that spec. In the meantime, |
| 22 | +hopefully this will do nicely. If I become aware of any official |
| 23 | +OpenAPI spec, I'll be sure to link it here. This repo will stay up |
| 24 | +regardless, for reliability. |
0 commit comments