CLI command naming consistency
Closed this issue · 2 comments
#792 restructured the object store commands, adding object-store-keys. I think we might want to take a step back and aim for consistency in naming. We now have
aclandacl-entrydictionaryanddictionary-itemobject-storeandobject-store-keyssecret-storeandsecret-store-entry
Tough to do anything about acl-entry and dictionary-item at this point (unless we added an alias) but I think there's still time to settle on a convention for object and secret store.
So in general, it's tricky trying to decide what to do because the API is so inconsistent.
For example, if you look at the OpenAPI specs for dictionaries it uses 'item' exclusively, but in the specs for config-store although you'll see it mainly uses 'item' it also uses the phrase 'entry' in multiple places. If we look at the specs for the object-store we'll see it uses 'keys' exclusively and for the secret-store it uses 'secret' exclusively.
I personally think 'item' isn't a great name, and that if anything we should lean towards 'entry' which is used more consistently in the CLI at the moment (that's also not a great name but it's a better choice IMHO).
All that said, I think they should all be consistent within the CLI because (and I've discussed this before with @fgsch) the CLI is a different interface to the API and users aren't thinking about (or even know about) the underlying API, so we shouldn't worry that dictionary-item (for example) becomes, let's say, dictionary-entry instead.
I believe we should have the following...
aclandacl-entryconfig-storeandconfig-store-entry(not actually implemented in the CLI yet)dictionaryanddictionary-entryobject-storeandobject-store-entrysecret-storeandsecret-store-entry