Allow OpenAPI on events
kernwig opened this issue · comments
Have you read the Contributing Guidelines on issues?
- I have read the Contributing Guidelines on issues.
Description
Enable use of OpenAPI MDX on events pages, as well as services. This is similar to the SchemaViewer MDX which allows rendering of JSON-schema on event pages.
Motivation
Ideally JSON-schema and OpenAPI would interoperate and events would be JSON-schema. Unfortunately the version of OpenAPI supported by EventCatalog (and most tools) is v3.0 which is not compatible with JSON-schema.
Therefor I'm using OpenAPI v3.0.4 spec consistently throughout the project for compatibility as well as a single language for authors to learn. Without OpenAPI MDX on event pages though, we are limited to which provides a raw YAML view instead of a nice rendering.
Hey @kernwig
Just merged a new feature that will now let you use OpenAPI in Events! Also updated the swagger-ui-react package to the latest one, hopefully this supports your OpenAPI versions.
Docs have been updated to help you get started.
Thanks for the idea!