documentation update

Author: sysgoblin

docs/en-US/Get-UrlScanioScan.md

@@ -13,7 +13,7 @@ Get urlscan.io scan results.
 ## SYNTAX
 
 ```
-Get-UrlScanioScan [-uuid] <String> [-Raw] [<CommonParameters>]
+Get-UrlScanioScan [-id] <String[]> [-Raw] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -31,18 +31,18 @@ Get urlscan.io report for the scan with uuid b14db0aa-013c-4aa9-ad5a-ec947a2278c
 
 ## PARAMETERS
 
-### -uuid
-UUID of scan to get details on.
+### -id
+Guid of scan to get details on.
 
 ```yaml
-Type: String
+Type: String[]
 Parameter Sets: (All)
-Aliases:
+Aliases: uuid, _id
 
 Required: True
 Position: 1
 Default value: None
-Accept pipeline input: True (ByPropertyName)
+Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 

docs/en-US/PSUrlScanio.md

@@ -1,25 +1,25 @@
 ---
 Module Name: PSUrlScanio
 Module Guid: 00ae67df-b1ae-400c-bcb4-dad7feba9db0
-Download Help Link: {{ Update Download Link }}
-Help Version: {{ Please enter version of help manually (X.X.X.X) format }}
+Download Help Link: {{ n/a }}
+Help Version: {{ 0.0.0.1 }}
 Locale: en-US
 ---
 
 # PSUrlScanio Module
 ## Description
-{{ Fill in the Description }}
+Powershell module for interacting with the urlscan.io api.
 
 ## PSUrlScanio Cmdlets
 ### [Connect-UrlScanio](Connect-UrlScanio.md)
-{{ Fill in the Description }}
+Create or update the urlscan.io config file which contains the API key used within the PSUrlScanio module.
 
 ### [Get-UrlScanioScan](Get-UrlScanioScan.md)
-{{ Fill in the Description }}
+Get urlscan.io scan results for the provided uuid.
 
 ### [Search-UrlScanio](Search-UrlScanio.md)
-{{ Fill in the Description }}
+Search urlscan.io using the provided parameters or providing a filter using Elasticsearch Query String syntax
+(https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
 
 ### [Start-UrlScanioScan](Start-UrlScanioScan.md)
-{{ Fill in the Description }}
-
+Start-UrlScanioScan triggers a scan of the specified URL.

docs/en-US/Search-UrlScanio.md

@@ -14,13 +14,21 @@ Search urlscan.io results.
 
 ### Filter
 ```
-Search-UrlScanio [-Filter <String>] [-Limit <Int32>] [-Raw] [<CommonParameters>]
+Search-UrlScanio [-Filter <String>] [-Limit <Int32>] [-All] [-Raw <String>] [-Specific] [-SortBy <String>]
+ [-Descending] [-Ascending] [<CommonParameters>]
 ```
 
 ### Params
 ```
 Search-UrlScanio [-Domain <String>] [-IP <String>] [-ASN <String>] [-ASNName <String>] [-Filename <String>]
- [-Hash <String>] [-Server <String>] [-Limit <Int32>] [-Raw] [<CommonParameters>]
+ [-Hash <String>] [-Server <String>] [-Limit <Int32>] [-All] [-Raw <String>] [-Specific] [-SortBy <String>]
+ [-Descending] [-Ascending] [<CommonParameters>]
+```
+
+### Sort
+```
+Search-UrlScanio [-Limit <Int32>] [-All] [-Raw <String>] [-Specific] [-SortBy <String>] [-Descending]
+ [-Ascending] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -175,9 +183,84 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -All
+Return all possible results up to a maximum of 10000. (Limit set by urlscan.io)
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Raw
 Return results as raw json.
 
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Specific
+Only return results where the page domain contains the specified domain. Default behaiviour is to return results where domain is called in any part of the page response.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SortBy
+{{ Fill SortBy Description }}
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Descending
+{{ Fill Descending Description }}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Ascending
+{{ Fill Ascending Description }}
+
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)

src/PSUrlScanio.psd1

@@ -12,7 +12,7 @@
 RootModule = 'PSUrlScanio.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.1.0'
+ModuleVersion = '0.1.5'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -24,7 +24,7 @@ GUID = '00ae67df-b1ae-400c-bcb4-dad7feba9db0'
 Author = 'Chris Bayliss'
 
 # Company or vendor of this module
-CompanyName = 'Unknown'
+# CompanyName = ''
 
 # Copyright statement for this module
 Copyright = '(c) Chris Bayliss. All rights reserved.'
@@ -33,7 +33,7 @@ Copyright = '(c) Chris Bayliss. All rights reserved.'
 Description = 'Powershell module for utilising the urlscan.io api.'
 
 # Minimum version of the PowerShell engine required by this module
-# PowerShellVersion = ''
+PowerShellVersion = '5.1'
 
 # Name of the PowerShell host required by this module
 # PowerShellHostName = ''
@@ -95,19 +95,19 @@ PrivateData = @{
     PSData = @{
 
         # Tags applied to this module. These help with module discovery in online galleries.
-        # Tags = @()
+        Tags = @('powershell', 'Windows', 'scan', 'urlscan')
 
         # A URL to the license for this module.
         # LicenseUri = ''
 
         # A URL to the main website for this project.
-        # ProjectUri = ''
+        ProjectUri = 'https://github.com/sysgoblin/PSURLScanio'
 
         # A URL to an icon representing this module.
         # IconUri = ''
 
         # ReleaseNotes of this module
-        # ReleaseNotes = ''
+        ReleaseNotes = 'https://github.com/sysgoblin/PSURLScanio/releases/tag/0.1.5'
 
         # Prerelease string of this module
         # Prerelease = ''