From f134bc6dcdf38b318d833132792df84865c3654e Mon Sep 17 00:00:00 2001
From: Philipp Heckel <pheckel@datto.com>
Date: Mon, 27 Jun 2022 12:21:11 -0400
Subject: [PATCH] Fix PowerShell rendering, changelog
---
docs/publish.md | 50 +++++++++++++++++++++++++-----------------------
docs/releases.md | 4 ++++
2 files changed, 30 insertions(+), 24 deletions(-)
diff --git a/docs/publish.md b/docs/publish.md
index c89a5406..b1bb09f8 100644
--- a/docs/publish.md
+++ b/docs/publish.md
@@ -883,25 +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 = "mytopic"
+ 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
```
=== "Python"
@@ -1233,7 +1233,7 @@ Alternatively, the same actions can be defined as **JSON array**, if the notific
}
)
} | 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"
@@ -1731,6 +1731,9 @@ And the same example using [JSON publishing](#publish-as-json):
=== "PowerShell"
``` powershell
+ # Powershell requires the 'Depth' argument to equal 3 here to expand 'Extras',
+ # otherwise it will read System.Collections.Hashtable in the returned JSON
+
$uri = "https://ntfy.sh"
$body = @{
topic = "wifey"
@@ -1745,9 +1748,6 @@ And the same example using [JSON publishing](#publish-as-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
```
@@ -2002,6 +2002,9 @@ And the same example using [JSON publishing](#publish-as-json):
=== "PowerShell"
``` powershell
+ # Powershell requires the 'Depth' argument to equal 3 here to expand 'headers',
+ # otherwise it will read System.Collections.Hashtable in the returned JSON
+
$uri = "https://ntfy.sh"
$body = @{
topic = "myhome"
@@ -2018,7 +2021,6 @@ And the same example using [JSON publishing](#publish-as-json):
body = '{"action": "close"}'
}
)
- # 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
```
diff --git a/docs/releases.md b/docs/releases.md
index 30ba0b7d..105e7a27 100644
--- a/docs/releases.md
+++ b/docs/releases.md
@@ -32,6 +32,10 @@ Thank you to [@wunter8](https://github.com/wunter8) for proactively picking up s
* `ntfy user` commands don't work with `auth_file` but works with `auth-file` ([#344](https://github.com/binwiederhier/ntfy/issues/344), thanks to [@Histalek](https://github.com/Histalek) for reporting)
+**Documentation:**
+
+* Fix some PowerShell publish docs ([#345](https://github.com/binwiederhier/ntfy/pull/345), thanks to [@noahpeltier](https://github.com/noahpeltier))
+
-->
## ntfy server v1.27.2