Skip to content

Commit

Permalink
Update doc references to ManifestIdentifier (#89)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamespik committed Nov 1, 2021
1 parent 24efb73 commit 1ac6f1d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions Tools/PowershellModule/doc/PowerShell/Get-WinGetManifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Allows for filtering results based on the name when targetting the REST APIs.

### Azure (Default)
```
Get-WinGetManifest [-FunctionName] <String> [[-ManifestIdentifier] <String>] [[-SubscriptionName] <String>]
Get-WinGetManifest [-FunctionName] <String> [[-PackageIdentifier] <String>] [[-SubscriptionName] <String>]
[<CommonParameters>]
```

Expand Down Expand Up @@ -52,14 +52,14 @@ Returns a Package Manifest object of the specified JSON file.

### EXAMPLE 3
```
Get-WinGetManifest -FunctionName "contosorestsource" -ManifestIdentifier "Windows.PowerToys"
Get-WinGetManifest -FunctionName "contosorestsource" -PackageIdentifier "Windows.PowerToys"
```

Returns an Manifest object of the specified Application Package Identifier that is queried against in the REST APIs.

### EXAMPLE 4
```
Get-WinGetManifest -FunctionName "contosorestsource" -ManifestIdentifier "Windows.PowerToys" -SubscriptionName "Visual Studio Subscription"
Get-WinGetManifest -FunctionName "contosorestsource" -PackageIdentifier "Windows.PowerToys" -SubscriptionName "Visual Studio Subscription"
```

Returns a Package Manifest object of the specified Package Identifier that is queried against in the REST APIs from the specified Subscription Name.
Expand Down Expand Up @@ -103,7 +103,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ManifestIdentifier
### -PackageIdentifier
\[Optional\] The Windows Package Manager Package Identifier of a specific Manifest result
```yaml
Expand Down
10 changes: 5 additions & 5 deletions Tools/PowershellModule/doc/PowerShell/Remove-WinGetManifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Removes a Manifest file from the Azure REST source

### WinGet (Default)
```
Remove-WinGetManifest [[-ManifestIdentifier] <String>] [[-SubscriptionName] <String>] [<CommonParameters>]
Remove-WinGetManifest [[-PackageIdentifier] <String>] [[-SubscriptionName] <String>] [<CommonParameters>]
```

### Azure
```
Remove-WinGetManifest [-FunctionName] <String> [[-ManifestIdentifier] <String>] [[-SubscriptionName] <String>]
Remove-WinGetManifest [-FunctionName] <String> [[-PackageIdentifier] <String>] [[-SubscriptionName] <String>]
[<CommonParameters>]
```

Expand All @@ -36,7 +36,7 @@ The following Azure Modules are used by this script:

### EXAMPLE 1
```
Remove-WinGetManifest -FunctionName "contosorestsource" -ManifestIdentifier "Windows.PowerToys"
Remove-WinGetManifest -FunctionName "contosorestsource" -PackageIdentifier "Windows.PowerToys"
```

Connects to Azure, then runs the Azure Function "contosorestsource" REST APIs to remove the specified Manifest file from the Windows Package Manager REST source
Expand All @@ -58,8 +58,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ManifestIdentifier
THe Manifest Id that represents the App Manifest to be removed.
### -PackageIdentifier
The Package Identifier that represents the App Manifest to be removed.
```yaml
Type: String
Expand Down
4 changes: 2 additions & 2 deletions Tools/PowershellModule/doc/new-winget-rest-source-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Alternatively, the `Get-WinGetManifest` PowerShell cmdlet supports targeting a s
The PowerShell Module must be re-imported each time the PowerShell window is closed. To get a Package Manifest open the Administrative PowerShell Window and run the following:

```PowerShell
PS C:\> Get-WinGetManifest -FunctionName "contoso" -ManifestIdentifier "Windows.PowerToys"
PS C:\> Get-WinGetManifest -FunctionName "contoso" -PackageIdentifier "Windows.PowerToys"
```

## Remove manifests from a REST source
Expand All @@ -103,7 +103,7 @@ The `Remove-WinGetManifest` PowerShell cmdlet supports targeting an existing Win
The PowerShell Module must be re-imported each time the PowerShell window is closed. To remove a Package Manifest open the Administrative PowerShell Window and run the following:

```PowerShell
PS C:\> Remove-WinGetManifest -FunctionName "contoso" -ManifestIdentifier "Windows.PowerToys"
PS C:\> Remove-WinGetManifest -FunctionName "contoso" -PackageIdentifier "Windows.PowerToys"
```

## Manage Windows Package Manager REST source manually
Expand Down

0 comments on commit 1ac6f1d

Please sign in to comment.