cloudevents
/
sdk-powershell
mirror of https://github.com/cloudevents/sdk-powershell.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove install instructions from an internal PS repository (#10) 

*  Addresses issue #1 removing the Install Instructions from the README.md. Once the initial release is published on the PowerShell Gallery the README.md will be updated with the install from PowerShell Gallery guide.
 *  Fixes minor typos in the README.md


Signed-off-by: Dimitar Milov <dmilov@vmware.com>
This commit is contained in:
dmilov 2021-04-09 10:09:01 +03:00 committed by GitHub
parent b2afcf89bd
commit 62f14b6b1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -13,8 +13,8 @@ The module contains functions to
- Create CloudEvent objects - Create CloudEvent objects
- Add data to a CloudEvent object - Add data to a CloudEvent object
- Read data from a CloudEvent object - Read data from a CloudEvent object
- Convert an CloudEvent object to an HTTP Message - Convert a CloudEvent object to an HTTP Message
- Convert an HTTP Message to an CloudEvent object - Convert an HTTP Message to a CloudEvent object
## Producer ## Producer
### Create a CloudEvent object ### Create a CloudEvent object
@ -34,7 +34,7 @@ $cloudEvent | Add-CloudEventJsonData -Data @{
### Add **XML Data** to a CloudEvent object ### Add **XML Data** to a CloudEvent object
```powershell ```powershell
$cloudEvent | Add-CloudEventXmlData -Data @{ $cloudEvent | Add-CloudEventXmlData -Data @{
'key1' = @{ 'key1' = @{
'key2' = 'value' 'key2' = 'value'
} }
@ -91,7 +91,7 @@ $hashtableData = Read-CloudEventJsonData -CloudEvent $cloudEvent
$hashtableData = Read-CloudEventXmlData -CloudEvent $cloudEvent -ConvertMode SkipAttributes $hashtableData = Read-CloudEventXmlData -CloudEvent $cloudEvent -ConvertMode SkipAttributes
``` ```
The `ConvertMode` parameter specifies how the XML to be represented in the result hashtable<br/> The `ConvertMode` parameter specifies how the XML to be represented in the result hashtable<br/>
`SkipAttributes` - Skips attributes of the XML elements. XmlElement is represented as a Key-Value pair where key is the xml element name, and the value is the xml element inner text<br/> `SkipAttributes` - Skips attributes of the XML elements. XmlElement is a Key-Value pair where Key is the Xml element name, and the value is the Xml element inner text<br/>
Example: Example:
```xml ```xml
<key att='true'>value1</key> <key att='true'>value1</key>
@ -100,8 +100,8 @@ is converted to
```powershell ```powershell
@{'key' = 'value-1'} @{'key' = 'value-1'}
``` ```
`AlwaysAttrValue` - Each element is represented as a hashtable with two keys<br/> `AlwaysAttrValue` - Each element is a HashTable with two keys<br/>
'Attributes' - key-value pair of the cml element attributes if any, otherwise null<br/> 'Attributes' - key-value pair of the Xml element attributes if any, otherwise null<br/>
'Value' - string value represinting the xml element inner text<br/> 'Value' - string value represinting the xml element inner text<br/>
Example: Example:
```xml ```xml
@ -186,28 +186,4 @@ Discovery finished in 176ms.
[+] C:\git-repos\cloudevents\cloudevents-sdk-powershell\test\integration\HttpIntegration.Tests.ps1 2.54s (1.77s|617ms) [+] C:\git-repos\cloudevents\cloudevents-sdk-powershell\test\integration\HttpIntegration.Tests.ps1 2.54s (1.77s|617ms)
Tests completed in 2.56s Tests completed in 2.56s
Tests Passed: 5, Failed: 0, Skipped: 0 NotRun: 0 Tests Passed: 5, Failed: 0, Skipped: 0 NotRun: 0
``` ```
# Install **CloudEvents.Sdk** Module
```powershell
$vmwareArtifactoryRepo = 'https://build-artifactory.eng.vmware.com/artifactory/api/nuget/powercli-nuget-local/'
Register-PSRepository -Name 'Artifactory' -SourceLocation $vmwareArtifactoryRepo -PublishLocation $vmwareArtifactoryRepo -InstallationPolicy Trusted
Install-Module CloudEvents.Sdk -Repository Artifactory
Import-Module CloudEvents.Sdk
Get-Command -Module CloudEvents.Sdk
ommandType Name Version Source
----------- ---- ------- ------
Function Add-CloudEventData 0.1.2 CloudEvents.Sdk
Function Add-CloudEventJsonData 0.1.2 CloudEvents.Sdk
Function Add-CloudEventXmlData 0.1.2 CloudEvents.Sdk
Function ConvertFrom-HttpMessage 0.1.2 CloudEvents.Sdk
Function ConvertTo-HttpMessage 0.1.2 CloudEvents.Sdk
Function New-CloudEvent 0.1.2 CloudEvents.Sdk
Function Read-CloudEventData 0.1.2 CloudEvents.Sdk
Function Read-CloudEventJsonData 0.1.2 CloudEvents.Sdk
Function Read-CloudEventXmlData 0.1.2 CloudEvents.Sdk
```