tlindsay42 / armorpowershell Goto Github PK

Would like to add dynamic ValidateSet cmdlet parameter validation for the ApiVersion parameter in all cmdlets so that the request schemas defined in Get-ArmorApiData become authoritative (ie: DRY)

Update comment-based help layout to match output

Add Class: ArmorCompleteWorkloadTier

Remove Verb-ArmorNoun

The Get-ArmorNoun and Update-ArmorNoun templates are sufficient

Replace Output comment-based help section w/ OutputType definition in cmdlets & strongly type $return

Remove-ArmorCompleteVM public cmdlet

https://docs.armor.com/display/KBSS/Delete+VM

Add Debug messages to cmdlets

Add automated tests for ArmorSession.ps1

Add new issue templates

Add separate bug and feature request issue templates.

Add ArmorSession GetAccountContextID method

Rename Get-ArmorApiData Endpoint parameter to FunctionName

Fix tag push logic

Consolidate redundant gather API data verbose messages (DRY)

    Write-Verbose -Message ( 'Gather API Data for {0}.' -f $function )

Add Code of Conduct page

Add Markdown file spell check to Windows & macOS builds

Fix (?:Start|Stop)-ArmorCompleteVM API data definition

Rename Start-ArmorVM to Start-ArmorCompleteVM and Stop-ArmorVM to Stop-ArmorCompleteVM in Get-ArmorApiData

build.ps1: Update-ModuleManifest @splat

Update cmdlet documentation

I've skipped a lot of cmdlet documentation in favor of releasing functionality and need to shore this up.

Phases

Add Synopsis, Description, & Input
Add Examples
Add Links w/ primary link targeting readthedocs.io

Add ParameterSets for cmdlets with both ID & name filtering parameters

Would like to improve user experience by specifying that only an ID or one or more filter parameters should be entered via ParameterSet

Update parameter format + add pipelining & mandatory where applicable

Standardize Pester return type tests

Add Pester tests for build scripts

Refactor Expand-JsonItem as a nested function in ConvertFrom-JsonXL

Move parameter documentation from help comment blocks to param blocks

Per Best Practice: https://github.com/PoshCode/PowerShellPracticeAndStyle/blob/9f578f883796dafa505f179dcc6fc93730e2a64c/Style-Guide/Documentation-and-Comments.md#document-each-parameter

Client-side filters do not work when key != value

Get-ArmorUser -UserName '[email protected]'
# Armor user not found.

Get-ArmorApiData -FunctionName Get-ArmorUser
<#
Description : Retrieves a list of users in your account
Endpoints   : {/users, /users/{id}}
Method      : Get
Body        :
Query       :
Location    :
Filter      : @{FirstName=FirstName; LastName=LastName; UserName=Email}
SuccessCode : 200
#>

tlindsay42 / armorpowershell Goto Github PK

armorpowershell's Issues

Recommend Projects

Recommend Topics

Recommend Org