Single Schema Dictionary Definitions Management Tool for Multiple AsyncAPI Definitions

[siathalysedI]

Single Schema Dictionary Definitions Management Tool for Multiple AsyncAPI Definitions

Hi everyone

Context

One thing I noticed an organization I have worked with is that as part of the API's governance process, once the schema validation is going on, a custom schema validator is used but the process to include new objects into the global schema dictionary for the whole organization is difficult because a json is kept to manage all of the schema definitions from all of the global AsyncAPI and OpenAPI schema definitions.

Description

In the case of AsyncAPI the data dictionary definitions being reviewed are: Channels Names, OperationId Names and Message Schemas (Header and Payloads)

Possible solution

So I think it would be great to have a visual management tool to incorporate or review global schema changes.

Alternatives

Maybe this could be extended to components, operations, channels, servers afterwards in general and next steps would be to relate this data dictionary into some validation tool so they are decoupled and even when the validation would be automatic, it would be referred to a central data dictionary.

Future vision

It would be great that this would relate to any part of the API definition and to have a reference meta schema like in #99_

Any comments are welcome
Best Regards

[naderafshari]

This is going to be very helpful for us as we have a large number of messages and we use generator to generate source code from it and as things work at the moment there is lack of practicality and flexibility. So we have to post process the generated source files with awk which not a desirable process.