Mismatch between docs and action requirements

[haysch]

Hello there,

I have started using the azure/bicep-deploy@v2 and used the examples in STACKS.md, however, there seems to be a mismatch between the description in "Delete" versus what fields are actually required by the action.

Some settings are left out from the example, i.e., deny-settings-mode and template-file, which makes the example incomplete.

[haysch]

In addition, from the "Delete deployment stacks" docs, the "Delete" example should not require neither the deny-settings-mode nor template-file, however, action-on-unmanage is missing.

So maybe field validation is too strict compared to what is actually required for the underlying API action?

[SydneyhSmith]

Thanks @haysch for opening the issue-- if you feel you know the fix feel free to submit a PR too

[haysch]

Thanks @haysch for opening the issue-- if you feel you know the fix feel free to submit a PR too

Might take a crack at it at some point if you don't get ahead of me 👍

[haysch]

Hi again @SydneyhSmith,

Just to discuss a potential solution/plan of attack:

• I can see that the deny-settings-mode is always required, which should be easy to deal with by conditionally require the field depending on operation.
• Same goes for scope/id - which is an optional field when reading the az stack group delete docs.
• Next up is the always required template file, which accepts FileConfig as parameter. Either one could extend that config type to contain a flag -OR- contain an extra argument that determines whether to look for/parse template/parameter files? In any case, it will likely be the type and operation tuple that determines whether the action requires files, in which case the logic could be embedded in the parsing if the function knew about the context. What do you think?

[SydneyhSmith]

Thanks @haysch that all sounds right to me