RabbitMQ definitions.json specification

[AndrewWinterman]

Is your feature request related to a problem? Please describe.

As a user, I may want to write custom definitions that get loaded when rabbitmq gets loaded, but there's no specification for the definitions.json file available in the documentation, or if there is I could not find it.

Describe the solution you'd like

A clear description of the definitions.json file format/syntx, possible leveraging https://json-schema.org/ or similar definition syntax.

Describe alternatives you've considered

No response

Additional context

No response

[michaelklishin]

You are welcome to contribute it. Hop's domain (Jackson) mappings should cover everything that matters for importing, in addition to

rabbitmqctl export_definitions "-" | jq

output. Besides runtime parameters and runtime parameters-based features such as policies and Shovels, the data structures are quite trivial.

Exported data is slightly extended, for example, virtual host definition import will take in metadata but output some metadata fields as virtual host object properties so that HTTP API client interfaces are easier to use. There are very few exceptions of this kind.