Documentation: Add parameter description and code example for m365 API

[TrygviZL]

While integrating the m365 into our CI/CD pipeline I was looking into using the API described here, but couldn't figure out how to pass parameters to the api without checking the code. An additional example of how to pass parameters would be great. I am thinking something like this to show how string and boolean parameters are passed:

executeCommand('status', {help: "response", verbose: true}, { output: 'text' })
  .then(res => {
    console.log(res.stdout)
  })

I can add a PR for this.

[milanholemans]

Hi @TrygviZL

We're sorry to hear that the docs are not clear enough. Therefore thank you for your valuable feedback, we appreciate it! I see we have 1 example right now that shows how you can provide additional options: executeCommand('spo web get', { webUrl: siteUrl, output: 'json' }).
We can opt to add an extra command in the example to make it more clear, but according to me, this should be somewhat relevant with the example we have now.
According to me, the example you are providing is not valid since you are providing 3 parameters to the executeCommand function while it expects only two. I think the last 2 objects should be combined to one object.

Would it be a good idea to modify the example @pnp/cli-for-microsoft-365-maintainers? We could:

• Refactor the code to use async/await, this will improve the readability a lot.
• Remove output: 'json' option since this is the default output now.
• Provide an extra useful command with more options to make clear how options are passed.

[TrygviZL]

@milanholemans

Thanks for your reply, I did not see the additional executeCommand call with parameters; my bad. A refactor of the code to use the more modern async await would be nice for readability. Let me know if I can give this a shot 🔫

[milanholemans]

@milanholemans

Thanks for your reply, I did not see the additional executeCommand call with parameters; my bad. A refactor of the code to use the more modern async await would be nice for readability. Let me know if I can give this a shot 🔫

Let's wait for a 2nd maintainer to approve what I suggested, after this we'll assign it to you.

[Jwaegebaert]

@TrygviZL thanks for creating this issue. I'm all aboard to refactor the code to async / await. That will make it a lot easier to read for users. I'll assign this task to you. If you have any questions along the way, we're always open to help 😄

[milanholemans]

@TrygviZL feel free to add some extra options to the spo web get command. https://pnp.github.io/cli-microsoft365/cmd/spo/web/web-get/
for example { withGroups: true }.