search

tikoci / restraml

RouterOS REST API "Schema Tools"
https://tikoci.github.io/restraml/
The Unlicense
12 stars 0 forks source link

`inspect.json` should use `_desc`, instead just `desc`, to match `_type` #11

Open mobileskyfi opened 3 months ago

mobileskyfi commented 3 months ago

The underscore become needed since RouterOS command tree overlapped and also used type as an argument to RouterOS command recently. This messed by the JavaScript for a bit — since it no longer knew if was a arg or cmd... And why _type got used in newer inspect.json's.

But when _type change, never changed desc is used.

Mainly for constancy, the _desc should be used to connote some inspect metadata – i.e. not a potential child. See #10 - where there could more "metadata" subitems.

NOTE

As long asdesc does not overlap with any "arg" to RouterOS commands, there is no issue.

mobileskyfi commented 3 months ago

And if fixed, all the schemas have to be regenerated so the diff still work as expected & not find difference in metadata.