💡Idea

The basic idea is to include command output in the command's doc.

🤔 Things to consider

General pointers

• We display every output format (JSON, Text, CSV)
• We normalize the data. For example, URLs are converted to 'contoso' as the tenant name
• We change any personal information included in the output
• If an option A returns a different output as option B, then we include both results
• If the command doesn't return an ouput. We write The command won't return a response on success.
• We added the Response header below the Examples header
• We make sure the *.md file always ends on a new line
• We don't shorten the ouput for readability
• Every list command will contain [ ] and a single reponse within the JSON output.

Examples

We can go on and on about the pointers but an example explains it much beter than written text. Below you'll find different examples for different scenarios. If you're missing a scenario, don't be afraid to ask us 😉

• A single object response (planner plan get)

The docs article
The MarkDown file location

• An object list response (planner plan list)

The docs article
The MarkDown file location

Note: Make sure the Text output is also in the list format with a single object.

• Multiple responses based on the options used (planner plan add)

The docs article
The MarkDown file location

• No response (planner plan remove)

The docs article
The MarkDown file location

🔍 Example issue

• Include response output: Planner bucket & Planner plan #3773
• Include md output: Planner bucket & Planner plan #4275

📃 Issues to be picked up

• Include response output: login, logout, request, version commands #4474
• Include response output: aad commands #3919
• Include response output: adaptivecards, app, booking commands #3920
• Include md output: adaptivecards, app, booking commands #4293
• Include response output: cli, search commands #3921
• Include md output: cli, search commands #4294
• Include response output: graph, onedrive, onenote commands #3922
• Include response output: outlook, planner, skype commands #3923
• Include response output: pa, pp commands #3924
• Include md output: pa, pp commands #4295
• Include response output: flow commands #4086
• Include md output: flow commands #4296
• Include response output: spfx commands #3925
• Include md output: spfx commands #4297
• Include response output: tenant commands #3926
• Include md output: tenant commands #4298
• Include response output: todo, util, viva commands #3927
• Include md output: todo, util, viva commands #4299
• Include response output: yammer commands #3928
• Include md output: yammer commands #4300
• Add response section for remaining commands in docs #5851

The larger command groups

SPO

• Include response output: spo app until spo eventreceiver commands #3929
• Include response output: spo externaluser until spo hidedefaultthemes commands #3930
• Include response output: spo homesite until spo navigation commands #3931
• Include md output: spo homesite until spo navigation commands #4301
• Include response output: spo orgassetslibrary until spo serviceprincipal commands #3932
• Include md output: spo orgassetslibrary until spo serviceprincipal commands #4302
• Include response output: spo site until spo theme commands #3933
• Include response output: spo user until spo web including the spo commands #3934
• Include md output: spo user until spo web including the spo commands #4303

Teams

• Include response output: teams app until teams membersettings commands #3935
• Include md output: teams app until teams membersettings commands #4304
• Include response output: teams message until teams user commands #3936
• Include md output: teams message until teams user commands #4305