You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Align input parameter names of hidi with kiota commandline tool #662
For multi-word parameters, should the convention be kebab case, or lower camel case?
Hidi should allow to set the logging level for by users.
Some parameters aliases conflict between the two tools. Those are for parameters that only apply to one tool. I don't think it's a big issue but I wanted to outline it just in case.
Name Alias Kiota Hidi
backing-store b ✔️ N/A
output o ✔️ ✔️
openapi d ✔️ ✔️
version v N/A ✔️
format f N/A ✔️
inline i N/A ✔️
resolveExternal ex N/A ✔️
filterByOperationIds op N/A ✔️
filterByTags t N/A ✔️
filterByCollection c N/A ✔️
language l ✔️ N/A
loglevel ll ✔️ ❌
class-name c ✔️ N/A
deserializer ds ✔️ N/A
namespace-name n ✔️ N/A
serializer s ✔️ N/A
Some differences:
For multi-word parameters, should the convention be kebab case, or lower camel case?
Hidi should allow to set the logging level for by users.
Some parameters aliases conflict between the two tools. Those are for parameters that only apply to one tool. I don't think it's a big issue but I wanted to outline it just in case.
I believe Darrel (@darrelmiller) can offer some insight on whether we should retain our camel-case naming convention for multi-name params or adopt the kebab case for consistency across both tools.
As for the conflicting params, I only identified --input and --output as the common aliases across both tools hence updated them. Will the other aliases be problematic and if so, how?
IMHO having colliding aliases for different parameters on the two tools is not a big issue, but I wanted to get the teams consensus on that aspect.
The bigger experience problems being the kebab/lower camel case for multiple word parameters and the logging aspect.
Activity
baywet commentedon Dec 14, 2021
for reference, here is kiota's parameters documentation at the moment, could you provide a reference for hidi's please?
https://microsoft.github.io/kiota/using.html
MaggieKimani1 commentedon Jan 24, 2022
Vincent Biret (@baywet), here is a link to hidi's documentation along with the parameters it accepts for both
transformandvalidatecommands.baywet commentedon Jan 24, 2022
Maggie Kimani (@MaggieKimani1) Thanks for sharing the information, here is the diff:
Some differences:
MaggieKimani1 commentedon Jan 24, 2022
Vincent Biret (@baywet) Thank you for outlining this in a visually presentable format!
--inputand--outputas the common aliases across both tools hence updated them. Will the other aliases be problematic and if so, how?baywet commentedon Jan 24, 2022
IMHO having colliding aliases for different parameters on the two tools is not a big issue, but I wanted to get the teams consensus on that aspect.
The bigger experience problems being the kebab/lower camel case for multiple word parameters and the logging aspect.
darrelmiller commentedon Jan 25, 2022
Vincent and I chatted.
baywet commentedon Jan 25, 2022
and lastly, add the loglevel parameter for observability, especially when people use the tool as part of a CI workflow.
MaggieKimani1 commentedon Jan 26, 2022
Noted.