inconsistent JSON keywords

[mwinter-osr]

This is not really a "bug", but wanted to record this for discussion.

On the various json outputs we have inconsistent names of the same fields

Example on OSPFv2 outputs:
on show ip ospf database json vs show ip ospf database external json:

advertisedRouter vs advertisingRouter
linkStateId vs lsId
lsaSeqNumber vs sequenceNumber

Same issue on various other outputs.

I don't think we can change these keys anymore (at least not once they are in a release)

Questions:

1. Thoughts on how to fix this?
   • Adding a second field with the other name?
   • Not fixing it at all?
2. Thoughts on avoiding this in the future?

[donaldsharp]

We've already fixed this a bunch of times

add the correct key as decided by the group, leaving the old one
mark the old one as deprecated and to be removed in the future.

If it's extremely new json that is not in a release just fix it.

[mwinter-osr]

Works for me.

I was also thinking about some way to avoid this to happen. But no idea how I could test this in a PR. Any ideas?
Or register new keywords somewhere, to avoid inventing new ones?

[donaldsharp]

I'm not sure where we can register the list of acceptable words that would make the developer check there when they couldn't be bothered to see if there was already an accepted word instead of inventing their own.

We as reviewers of the code just need to be cognizant of this and try to keep it in mind.

[ton31337]

Something like Reviewer checklist would be handy :)

[qlyoung]

Don't know how to handle this other than fixing it when it crops up and hoping we catch it in review.

[idryzhov]

Implement more NB operational data callbacks instead of these manual JSON representations. This way every output will be according to the YANG model 😉