Merge pull request #2492 from microsoftgraph/2453-missing-ms-learn-api-docs-examples-for-powershell-commands

timayabi2020 · web-flow · commit 1ebab546304d · 2024-01-08T08:33:56.000+03:00
Rectifies metadata path information for paths containing Microsoft.Graph prefix in nested segments.
diff --git a/src/Authentication/Authentication/custom/common/GraphUri.ps1 b/src/Authentication/Authentication/custom/common/GraphUri.ps1
@@ -103,14 +103,21 @@ function GraphUri_RemoveNamespaceFromActionFunction {
     $ActionFunctionFQNPattern = "\/Microsoft.Graph.(.*)$"
 
     $NewUri = $Uri
-    # Remove FQN in action/function names.
+    # Remove FQN in paths.
     if ($Uri -match $ActionFunctionFQNPattern) {
         $MatchedUriSegment = $Matches.0
+        $SegmentBuilder = ""
         # Trim nested namespace segments.
-        $NestedNamespaceSegments = $Matches.1 -split "\."
-        # Remove trailing '()' from functions.
-        $LastSegment = $NestedNamespaceSegments[-1] -replace "\(\)", ""
-        $NewUri = $Uri -replace [Regex]::Escape($MatchedUriSegment), "/$LastSegment"
+        $NestedNamespaceSegments = $Matches.1 -split "/"
+        foreach($Segment in $NestedNamespaceSegments){
+            # Remove microsoft.graph prefix and trailing '()' from functions.
+            $Segment = $segment.Replace("microsoft.graph.","").Replace("()", "")
+            # Get resource object name from segment if it exists. e.g get 'updateAudience' from windowsUpdates.updateAudience
+            $ResourceObj = $Segment.Split(".")
+            $Segment = $ResourceObj[$ResourceObj.Count-1]
+            $SegmentBuilder += "/$Segment"
+        }
+        $NewUri = $Uri -replace [Regex]::Escape($MatchedUriSegment), $SegmentBuilder
     }
 
     return $NewUri
diff --git a/src/Authentication/Authentication/custom/common/MgCommandMetadata.json b/src/Authentication/Authentication/custom/common/MgCommandMetadata.json
@@ -95132,7 +95132,7 @@
   },
   {
     "Module": "Beta.Identity.SignIns",
-    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders",
+    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders",
     "OutputType": "IMicrosoftGraphIdentityProviderBase",
     "Method": "GET",
     "ApiVersion": "beta",
@@ -95208,7 +95208,7 @@
   },
   {
     "Module": "Beta.Identity.SignIns",
-    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref",
+    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref",
     "OutputType": null,
     "Method": "GET",
     "ApiVersion": "beta",
@@ -95220,7 +95220,7 @@
   },
   {
     "Module": "Beta.Identity.SignIns",
-    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$count",
+    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$count",
     "OutputType": null,
     "Method": "GET",
     "ApiVersion": "beta",
@@ -305344,7 +305344,7 @@
   },
   {
     "Module": "Beta.Identity.SignIns",
-    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref",
+    "Uri": "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref",
     "OutputType": null,
     "Method": "POST",
     "ApiVersion": "beta",
diff --git a/src/Authentication/Authentication/test/Find-MgGraphCommand.Tests.ps1 b/src/Authentication/Authentication/test/Find-MgGraphCommand.Tests.ps1
@@ -138,7 +138,7 @@ Describe "Find-MgGraphCommand Command" {
                 $MgCommand.Command | Should -Be @("Get-MgReportSharePointActivityUserCount", "Get-MgBetaReportSharePointActivityUserCount")
             } | Should -Not -Throw    
         }
-        It 'Should find commands for uri woth /me segments' {
+        It 'Should find commands for uri with /me segments' {
             {
                 $MgCommand = Find-MgGraphCommand -Uri "/me/events/"
                 $MgCommand | Should -HaveCount 4
@@ -150,7 +150,7 @@ Describe "Find-MgGraphCommand Command" {
                 $MgCommand.Command | Select-Object -Unique | Should -BeIn @("New-MgUserEvent", "Get-MgUserEvent", "New-MgBetaUserEvent", "Get-MgBetaUserEvent")
             } | Should -Not -Throw
         }
-        It 'Should find commands for uri woth /me segments' {
+        It 'Should find commands for uri with /me segments' {
             {
                 $MgCommand = Find-MgGraphCommand -Uri "https://graph.microsoft.com/v1.0/me/events/"
                 $MgCommand | Should -HaveCount 4
@@ -162,6 +162,18 @@ Describe "Find-MgGraphCommand Command" {
                 $MgCommand.Command | Select-Object -Unique | Should -BeIn @("New-MgUserEvent", "Get-MgUserEvent", "New-MgBetaUserEvent", "Get-MgBetaUserEvent")
             } | Should -Not -Throw
         }
+        It 'Should find commands for uri with Microsoft.Graph prefix in nested segments' {
+            {
+                $MgCommand = Find-MgGraphCommand -Uri "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders"
+                $MgCommand | Should -HaveCount 1
+                $MgCommand.Command | Select-Object -Unique | should -HaveCount 1
+                $MgCommand.Method | Select-Object -Unique | should -HaveCount 1
+                $MgCommand.APIVersion | Select-Object -Unique | should -HaveCount 1
+                $MgCommand.Variants | Select-Object -Unique | should -HaveCount 1
+                $MgCommand.URI | Select-Object -Unique | Should -Be "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders"
+                $MgCommand.Command | Select-Object -Unique | Should -BeIn @("Get-MgBetaIdentityAuthenticationEventFlowAsOnAuthenticationMethodLoadStartExternalUserSelfServiceSignUpIdentityProvider")
+            } | Should -Not -Throw
+        }
     }
 
     Context "FindByCommand" {
diff --git a/tools/PostGeneration/NewCommandMetadata.ps1 b/tools/PostGeneration/NewCommandMetadata.ps1
@@ -58,16 +58,22 @@ $ApiVersion | ForEach-Object {
             $Method = $Matches.2
             $Uri = $Matches.3
 
-            # Remove FQN in action/function names.
+            # Remove FQN in paths.
             if ($Uri -match $ActionFunctionFQNPattern) {
                 $MatchedUriSegment = $Matches.0
+                $SegmentBuilder = ""
                 # Trim nested namespace segments.
-                $NestedNamespaceSegments = $Matches.1 -split "\."
-                # Remove trailing '()' from functions.
-                $LastSegment = $NestedNamespaceSegments[-1] -replace "\(\)", ""
-                $Uri = $Uri -replace [Regex]::Escape($MatchedUriSegment), "/$LastSegment"
+                $NestedNamespaceSegments = $Matches.1 -split "/"
+                foreach($Segment in $NestedNamespaceSegments){
+                    # Remove microsoft.graph prefix and trailing '()' from functions.
+                    $Segment = $segment.Replace("microsoft.graph.","").Replace("()", "")
+                    # Get resource object name from segment if it exists. e.g get 'updateAudience' from windowsUpdates.updateAudience
+                    $ResourceObj = $Segment.Split(".")
+                    $Segment = $ResourceObj[$ResourceObj.Count-1]       
+                    $SegmentBuilder += "/$Segment"
+                }
+                $Uri = $Uri -replace [Regex]::Escape($MatchedUriSegment), $SegmentBuilder
             }
-
             $MappingValue = @{
                 Command     = $CommandName
                 Variants    = [System.Collections.ArrayList]@($VariantName)

Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ Describe "Find-MgGraphCommand Command" {`
`138`	`138`	`$MgCommand.Command \| Should -Be @("Get-MgReportSharePointActivityUserCount", "Get-MgBetaReportSharePointActivityUserCount")`
`139`	`139`	`} \| Should -Not -Throw`
`140`	`140`	`}`
`141`		`- It 'Should find commands for uri woth /me segments' {`
	`141`	`+ It 'Should find commands for uri with /me segments' {`
`142`	`142`	`{`
`143`	`143`	`$MgCommand = Find-MgGraphCommand -Uri "/me/events/"`
`144`	`144`	`$MgCommand \| Should -HaveCount 4`
`@@ -150,7 +150,7 @@ Describe "Find-MgGraphCommand Command" {`
`150`	`150`	`$MgCommand.Command \| Select-Object -Unique \| Should -BeIn @("New-MgUserEvent", "Get-MgUserEvent", "New-MgBetaUserEvent", "Get-MgBetaUserEvent")`
`151`	`151`	`} \| Should -Not -Throw`
`152`	`152`	`}`
`153`		`- It 'Should find commands for uri woth /me segments' {`
	`153`	`+ It 'Should find commands for uri with /me segments' {`
`154`	`154`	`{`
`155`	`155`	`$MgCommand = Find-MgGraphCommand -Uri "https://graph.microsoft.com/v1.0/me/events/"`
`156`	`156`	`$MgCommand \| Should -HaveCount 4`
`@@ -162,6 +162,18 @@ Describe "Find-MgGraphCommand Command" {`
`162`	`162`	`$MgCommand.Command \| Select-Object -Unique \| Should -BeIn @("New-MgUserEvent", "Get-MgUserEvent", "New-MgBetaUserEvent", "Get-MgBetaUserEvent")`
`163`	`163`	`} \| Should -Not -Throw`
`164`	`164`	`}`
	`165`	`+ It 'Should find commands for uri with Microsoft.Graph prefix in nested segments' {`
	`166`	`+ {`
	`167`	`+ $MgCommand = Find-MgGraphCommand -Uri "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders"`
	`168`	`+ $MgCommand \| Should -HaveCount 1`
	`169`	`+ $MgCommand.Command \| Select-Object -Unique \| should -HaveCount 1`
	`170`	`+ $MgCommand.Method \| Select-Object -Unique \| should -HaveCount 1`
	`171`	`+ $MgCommand.APIVersion \| Select-Object -Unique \| should -HaveCount 1`
	`172`	`+ $MgCommand.Variants \| Select-Object -Unique \| should -HaveCount 1`
	`173`	`+ $MgCommand.URI \| Select-Object -Unique \| Should -Be "/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders"`
	`174`	`+ $MgCommand.Command \| Select-Object -Unique \| Should -BeIn @("Get-MgBetaIdentityAuthenticationEventFlowAsOnAuthenticationMethodLoadStartExternalUserSelfServiceSignUpIdentityProvider")`
	`175`	`+ } \| Should -Not -Throw`
	`176`	`+ }`
`165`	`177`	`}`
`166`	`178`
`167`	`179`	`Context "FindByCommand" {`