Cli-microsoft365: Update 'spo list webhook list' command parameters

Created on 4 Jan 2019  路  8Comments  路  Source: pnp/cli-microsoft365

Summary

Current behavior

Currently, with the spo list webhook list command, you have to use the following parameters :

  • -i, --id [id] of list
  • -t, --title [title] of list

Expected behavior

Instead of :

  • -i, --id [id] of list
  • -t, --title [title] of list

use :

  • --listId
  • --listTitle

since all other cmdlets use this parameters (keep coherence with other cmdlets)

To Do

  • [x] Update command from solution
  • [x] Update documentation of usage (MkDocs)
  • [x] Validate Unit test
  • [x] Validate cmdlet usage
enhancement work in progress

All 8 comments

Good catch. To avoid breaking change, we'd need to introduce these options along the existing ones instead of replacing them. For the old ones, we'd display a deprecation warning. See https://github.com/pnp/office365-cli/blob/a9b3c8a892da0e2caf8f5d0fd40d99303c29666e/src/o365/spo/commands/site/site-add.ts#L80-L82 for how that's implemented.

Hey @Laul0 are you still working on this?

I'm trying to fix my spec first and after that I'll work on it

@waldekmastykarz Question about the documentation and help : do you prefer to update the documentation with the new options or to keep the old ones and add "deprecated" into the comment ? And update the examples with the new ones ?

If options title and listTitle are define, do you want a warning too ? An error ? Nothing ? By default, that cause no problem with the script

@Laul0 for completeness we should be listing all available options, marking the old ones as deprecated. As you suggested, it would be good to update examples to use the recommended options

It's what I did. My PR should be ready

Perfect! I'll have a look shortly

Was this page helpful?
0 / 5 - 0 ratings