Skip to content

Feature Request: Protobuf schema format support in AsyncAPI pages #4419

@zhenyakovalyov

Description

@zhenyakovalyov

Currently, Mintlify's AsyncAPI integration supports WebSocket channel documentation from AsyncAPI 3.0+ specs in JSON/YAML format, which works well for JSON Schema payloads. However, there is no support for protobuf-encoded message schemas via the schemaFormat field.

The AsyncAPI spec itself supports protobuf payloads using application/vnd.google.protobuf;version=3 as the schemaFormat, and the AsyncAPI ecosystem has a dedicated parser for this (@asyncapi/protobuf-schema-parser).

Use case: We document a platform where some WebSocket channels carry protobuf-encoded messages. We would like to reference our .proto definitions (or inline proto schemas) in our AsyncAPI spec and have Mintlify render the message structure in the API playground, the same way it does for JSON Schema payloads today.

Request: Would it be possible to integrate protobuf schema parsing into Mintlify's AsyncAPI renderer, either via the existing @asyncapi/protobuf-schema-parser package or a similar approach? Fallback rendering (e.g. displaying the raw proto schema as a code block) would also be a useful intermediate step.

Happy to provide a minimal reproducible AsyncAPI spec as an example if that helps.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions