Tyk sync’s outputs could be more human readable if they only exported the settings which were not default.
As an example, at present I have a tyk gateway configured with 5 test endpoints. Running tyk-sync dump against this instance creates 5 json files with 457 lines each. The challenge here is that aside from ~3 settings that aren’t default.
From a developer experience and long term scalability perspective if the objects that are output by tyk sync were optionally “slimline” developers would likely have a much easier time of understanding what’s going on AND potentially get to a point where simpler endpoints could be built outside of the GUI interface.
some examples of things I feel are probably extraneous. If use_basic_auth is false, then the entire basic auth object doesn’t have to be included… and SINCE that use_basic_auth key is false by default, that doesn’t have to be included either.
Interesting! These are great leads thanks. I’m happy to take away the idea that verbosity in CI/CD land becomes an advantage … though … is there any argument or reasoning behind that? What cases make that an advantage long term?
I’d love to be able to explain that in clear terms to anyone who questions me on it.
Verbosity means there are no assumptions or implicit defaults. Everything is defined explicitly. The cost of this of course is a field overload. As your post suggests, users would rather have sensible defaults hidden instead of defined.
The current format is not dev friendly. The new OAS API definition and the Tyk Operator will fix this!