https://github.com/sigpwned/diffbot-openapi-spec
Community OpenAPI Spec for Diffbot API
https://github.com/sigpwned/diffbot-openapi-spec
diffbot diffbot-api openapi openapi-spec openapi-specification
Last synced: 3 months ago
JSON representation
Community OpenAPI Spec for Diffbot API
- Host: GitHub
- URL: https://github.com/sigpwned/diffbot-openapi-spec
- Owner: sigpwned
- License: apache-2.0
- Created: 2023-08-14T01:11:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-14T02:08:17.000Z (almost 2 years ago)
- Last Synced: 2025-01-27T10:29:49.906Z (4 months ago)
- Topics: diffbot, diffbot-api, openapi, openapi-spec, openapi-specification
- Language: jq
- Homepage: https://github.com/sigpwned/diffbot-openapi-spec
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# diffbot-openapi-spec
A community-managed OpenAPI spec for the (excellent)
[Diffbot](https://www.diffbot.com/) [API](https://docs.diffbot.com/).
Unfortunately, Diffbot does not appear to publish a public OpenAPI
spec. However, with a little coaxing, it's possible to extract a
(generally) OpenAPI spec-shaped object from [its documentation
platform](https://docs.diffbot.com/). (The curious can check the
Makefile to see how this is done.) This project simply pulls down that
OpenAPI-shaped object, massages it into compliance with [v3.0.x of the
OpenAPI spec](https://spec.openapis.org/oas/v3.0.3.html), and makes
releases available for general download.
The spec itself may be found under the "releases" section of this
repo.
At this time, the author only requires the extract
endpoints. Therefore, only the extract endpoints are currently
supported. However, the process to add more endpoints is described in
the Makefile, and all PRs are welcome.
Naturally, if at any point Diffbot should release an OpenAPI spec
publicly, users should immediately prefer that spec. In the meantime,
hopefully this will do nicely. If I become aware of any official
OpenAPI spec, I'll be sure to link it here. This repo will stay up
regardless, for reliability.