Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated syntax on PowerShell examples in docs #345

Merged
merged 2 commits into from
Jun 27, 2022
Merged

Updated syntax on PowerShell examples in docs #345

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb84160
Updated powershell examples to correct syntax
Jun 27, 2022
ae37152
Updated powershell docs to correct syntax, fixed my goofy typos
Jun 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 58 additions & 49 deletions docs/publish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,19 +883,25 @@ is the only required one:

=== "PowerShell"
``` powershell
$uri = "https://ntfy.sh"
$body = @{
"topic"="powershell"
"title"="Low disk space alert"
"message"="Disk space is low at 5.1 GB"
"priority"=4
"attach"="https://filesrv.lan/space.jpg"
"filename"="diskspace.jpg"
"tags"=@("warning","cd")
"click"= "https://homecamera.lan/xasds1h2xsSsa/"
"actions"=@[@{ "action"="view", "label"="Admin panel", "url"="https://filesrv.lan/admin" }]
} | ConvertTo-Json
Invoke-RestMethod -Method 'Post' -Uri $uri -Body $body -ContentType "application/json" -UseBasicParsing
$uri = "https://ntfy.sh"
$body = @{
topic = "powershell"
title = "Low disk space alert"
message = "Disk space is low at 5.1 GB"
priority = 4
attach = "https://filesrv.lan/space.jpg"
filename = "diskspace.jpg"
tags = @("warning", "cd")
click = "https://homecamera.lan/xasds1h2xsSsa/"
actions = @(
@{
action = "view"
label = "Admin panel"
url = "https://filesrv.lan/admin"
}
)
} | ConvertTo-Json
Invoke-RestMethod -Method 'Post' -Uri $uri -Body $body -ContentType "application/json" -UseBasicParsing
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has to be aligned with the three backticks, otherwise it won't render properly.

```

=== "Python"
Expand Down Expand Up @@ -1210,24 +1216,24 @@ Alternatively, the same actions can be defined as **JSON array**, if the notific
``` powershell
$uri = "https://ntfy.sh"
$body = @{
"topic"="myhome"
"message"="You left the house. Turn down the A/C?"
"actions"=@(
topic = "myhome"
message = "You left the house. Turn down the A/C?"
actions = @(
@{
"action"="view"
"label"="Open portal"
"url"="https://home.nest.com/"
"clear"=true
action = "view"
label = "Open portal"
url = "https://home.nest.com/"
clear = $true
},
@{
"action"="http",
"label"="Turn down"
"url"="https://api.nest.com/"
"body"="{\"temperature\": 65}"
action = "http"
label = "Turn down"
url = "https://api.nest.com/"
body = '{"temperature": 65}'
}
)
} | ConvertTo-Json
Invoke-RestMethod -Method 'Post' -Uri $uri -Body $body -ContentType "application/json" -UseBasicParsing
Invoke-RestMethod -Method 'Post' -Uri $uri -Body $body -ContentType "application/json" -UseBasicParsing
```

=== "Python"
Expand Down Expand Up @@ -1470,9 +1476,9 @@ And the same example using [JSON publishing](#publish-as-json):
``` powershell
$uri = "https://ntfy.sh"
$body = @{
"topic"="myhome"
"message"="Somebody retweetet your tweet."
"actions"=@(
topic = "myhome"
message = "Somebody retweetet your tweet."
actions = @(
@{
"action"="view"
"label"="Open Twitter"
Expand Down Expand Up @@ -1727,19 +1733,22 @@ And the same example using [JSON publishing](#publish-as-json):
``` powershell
$uri = "https://ntfy.sh"
$body = @{
"topic"="wifey"
"message"="Your wife requested you send a picture of yourself."
"actions"=@(
topic = "wifey"
message = "Your wife requested you send a picture of yourself."
actions = @(
@{
"action"="broadcast"
"label"="Take picture"
"extras"=@{
"cmd"="pic"
"camera"="front"
action = "broadcast"
label = "Take picture"
extras = @{
cmd ="pic"
camera = "front"
}
}
)
} | ConvertTo-Json

# Powershell requires the 'Depth' argument to equal 3 here to expand 'Extras', otherwise it will read System.Collections.Hashtable in the returned json

} | ConvertTo-Json -Depth 3
Invoke-RestMethod -Method 'Post' -Uri $uri -Body $body -ContentType "application/json" -UseBasicParsing
```

Expand Down Expand Up @@ -1995,22 +2004,22 @@ And the same example using [JSON publishing](#publish-as-json):
``` powershell
$uri = "https://ntfy.sh"
$body = @{
"topic"="myhome"
"message"="Garage door has been open for 15 minutes. Close it?"
"actions"=@(
topic = "myhome"
message = "Garage door has been open for 15 minutes. Close it?"
actions = @(
@{
"action"="http",
"label"="Close door"
"url"="https://api.mygarage.lan/"
"method"="PUT"
"headers"=@{
"Authorization"="Bearer zAzsx1sk.."
action = "http"
label = "Close door"
url = "https://api.mygarage.lan/"
method = "PUT"
headers = @{
Authorization = "Bearer zAzsx1sk.."
}
"body"="{\"action\": \"close\"}"
body = '{"action": "close"}'
}
}
)
} | ConvertTo-Json
# Powershell requires the 'Depth' argument to equal 3 here to expand 'headers', otherwise it will read System.Collections.Hashtable in the returned json
} | ConvertTo-Json -Depth 3
Invoke-RestMethod -Method 'Post' -Uri $uri -Body $body -ContentType "application/json" -UseBasicParsing
```

Expand Down