Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Proper Parameter Description in Help Synopsis for Microsoft.Graph.Entra Module #1112

Open
HCRitter opened this issue Sep 25, 2024 · 0 comments
Labels

Comments

@HCRitter
Copy link
Contributor

Thanks for reporting the bug. Please ensure you've gone through the following checklist before opening an issue:

  • Make sure you can reproduce this issue using the latest released version of Microsoft.Graph.Entra or Microsoft.Graph.Entra.Beta.
  • Please search the existing issues to see if there has been a similar issue filed.

Describe the bug

Several commands in the Microsoft.Graph.Entra module have incomplete or insufficient descriptions in their Help synopsis for the parameters.

To Reproduce

Steps to reproduce the behavior:

  1. Run the following PowerShell command:
   Get-Help <Command-Name> -Parameters
  1. Observe that the returned parameters are missing a description.

Expected behavior

The Get-Help command should return proper, fully documented parameter description

Debug Output

The following commands have no description with the examples:

FunctionName ParameterInFunction ParameterWithoutDescription
Find-EntraPermission 6 Online
Get-EntraContext 1 ProgressAction
New-EntraCustomHeaders 1 Command

Module Version

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     0.16.0     preview    Microsoft.graph.Entra               {Add-EntraAdministrativeUnitMember, Add-EntraAppli

Environment Data

Name                           Value
----                           -----
PSVersion                      7.4.5
PSEdition                      Core
GitCommitId                    7.4.5
OS                             Microsoft Windows 10.0.19045
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Screenshots

If applicable, add screenshots to help explain your problem.

Additional context
To extract that information I have used my Module: PSModuleAnalyzer

HCRitter added a commit to HCRitter/entra-powershell that referenced this issue Sep 26, 2024
The specifications for missing parameter descriptions have been fixed
SteveMutungi254 added a commit that referenced this issue Sep 29, 2024
* fixed Issue #1110

All typos except of `Get-EntraUnsupportedCommand` has been fixed

* fixes for Issue #1112

The specifications for missing parameter descriptions have been fixed

* Update module/Entra/AdditionalFunctions/New-EntraCustomHeaders.ps1

---------

Co-authored-by: Steve Mutungi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant