Merge pull request #100 from dataplat/credits

Added Credits to all functions that missed it #89

Author: NowinskiK

CHANGELOG.md

@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- Added credits for authors to all functions and Unit tests to verify the existence of such tags #89
+
 ### Changed
 ### Fixed
 ### Deprecated

helper/GetFunctionList.ps1

@@ -1,10 +1,11 @@
 $path = ".\source\public"
 $op = Get-ChildItem -Path $path -Recurse -Filter *.ps1 | Select-Object -ExpandProperty Name | Sort-Object
-#$op = $op | ForEach-Object { "        ""$_""," }
-$op | Out-File '.\Output\FunctionList-main-public.txt'
+$op | Out-File '.\output\FunctionList-main-public.txt'
 
 # Author Table
 # This script generates a table of PowerShell script authors from the specified directory.
+$path = ".\source\public"
+$op = Get-ChildItem -Path $path -Recurse -Filter *.ps1
 $authorTable = @{}
 $op | ForEach-Object {
     $file = $_.FullName
@@ -18,7 +19,10 @@ $op | ForEach-Object {
         $authorTable[$name] = $null
     }
 }
-$authorTable
+$authorTable | ft -AutoSize
+$authorTable.GetEnumerator() | Where-Object { -not $_.Value } | ft -AutoSize
+
+
 
 ## Not a singular name option for functions (#26)
 Get-Command -Module FabricTools |where Name -like '*s'

source/Public/Capacity/Get-FabricCapacities.ps1

@@ -19,7 +19,7 @@
     This command retrieves all resources of type "Microsoft.Fabric/capacities" from all resource groups in all subscriptions.
 
 .NOTES
-    Author : Ioana Bouariu @jojobit  Nov 10, 2023
+    Author: Ioana Bouariu
     Imported into FabricTools April 2025
     Alias: Get-AllFabCapacities
 #>

source/Public/Capacity/Get-FabricCapacityRefreshables.ps1

@@ -16,9 +16,11 @@ This example retrieves the top 5 refreshable capacities for the tenant.
 
 .NOTES
 The function retrieves the PowerBI access token and makes a GET request to the PowerBI API to retrieve the top refreshable capacities. It then returns the 'value' property of the response, which contains the capacities.
+
+Author: Ioana Bouariu
+
     #>
 
-    # This function retrieves the top refreshable capacities for the tenant.
     # Define aliases for the function for flexibility.
     [Alias("Get-FabCapacityRefreshables")]
 

source/Public/Capacity/Get-FabricCapacitySkus.ps1

@@ -19,8 +19,12 @@ Specifies the capacity to retrieve information for. If not provided, all capacit
 .EXAMPLE
 Get-FabricCapacitySkus -capacity "exampleCapacity"
 Retrieves the fabric capacity information for the specified capacity.
-    #>
-    # Define aliases for the function for flexibility.
+
+.NOTES
+
+Author: Kamil Nowinski
+
+#>
 
     Param(
         [Parameter(Mandatory = $true)]

source/Public/Capacity/Get-FabricCapacityState.ps1

@@ -22,6 +22,9 @@ This example retrieves the state of a specific capacity given the subscription I
 
 .NOTES
 The function checks if the Azure token is null. If it is, it connects to the Azure account and retrieves the token. It then defines the headers for the GET request and the URL for the GET request. Finally, it makes the GET request and returns the response.
+
+Author: Ioana Bouariu
+
     #>
 
     # This function retrieves the state of a specific capacity.

source/Public/Capacity/Get-FabricCapacityTenantOverrides.ps1

@@ -13,6 +13,9 @@ This example retrieves the tenant overrides for all capacities.
 
 .NOTES
 The function retrieves the PowerBI access token and makes a GET request to the Fabric API to retrieve the tenant overrides for all capacities. It then returns the response of the GET request.
+
+Author: Ioana Bouariu
+
     #>
 
     # This function retrieves the tenant overrides for all capacities.

source/Public/Capacity/Get-FabricCapacityWorkload.ps1

@@ -16,6 +16,9 @@ This example retrieves the workloads for a specific capacity given the capacity
 
 .NOTES
 The function retrieves the PowerBI access token and makes a GET request to the PowerBI API to retrieve the workloads for the specified capacity. It then returns the 'value' property of the response, which contains the workloads.
+
+Author: Ioana Bouariu
+
     #>
 
     # This function retrieves the workloads for a specific capacity.

source/Public/Capacity/Resume-FabricCapacity.ps1

@@ -22,9 +22,10 @@ This example resumes a capacity given the subscription ID, resource group, and c
 
 .NOTES
 The function defines parameters for the subscription ID, resource group, and capacity. If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI.
-    #>
 
-    # This function resumes a capacity.
+Author: Ioana Bouariu
+
+    #>
 
     # Define aliases for the function for flexibility.
     [Alias("Resume-FabCapacity")]

source/Public/Capacity/Suspend-FabricCapacity.ps1

@@ -23,6 +23,9 @@ This example suspends a capacity given the subscription ID, resource group, and
 
 .NOTES
 The function defines parameters for the subscription ID, resource group, and capacity. If the 'azToken' environment variable is null, it connects to the Azure account and sets the 'azToken' environment variable. It then defines the headers for the request, defines the URI for the request, and makes a GET request to the URI.
+
+Author: Ioana Bouariu
+
     #>
 
     # Define aliases for the function for flexibility.