Skip to content

Commit 4cd4886

Browse files
📖 [Docs]: Fix Connect-Confluence examples to use -Site/-CloudId and align blog post scope
1 parent 9f23e48 commit 4cd4886

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Connect with a scoped Atlassian API token, then call the resource commands. The
2222
```powershell
2323
# Connect and store a reusable, named credential profile
2424
$token = Read-Host -AsSecureString # a scoped Atlassian API token
25-
Connect-Confluence -ApiBaseUri 'https://api.atlassian.com/ex/confluence/<cloudId>' -Username 'you@example.com' -Token $token -SpaceKey 'DOCS'
25+
Connect-Confluence -Site 'yoursite' -Username 'you@example.com' -Token $token -SpaceKey 'DOCS'
2626
2727
# Work with content
2828
$space = Get-ConfluenceSpace -Key 'DOCS'

‎examples/Connecting.ps1‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,13 @@ Import-Module -Name 'Confluence'
1616
###
1717

1818
# Connect with a scoped Atlassian API token and store a reusable default profile.
19+
# -Site takes a subdomain, host, or any URL on the site and resolves the cloud ID for you.
1920
$token = Read-Host -AsSecureString # a scoped Atlassian API token
20-
Connect-Confluence -ApiBaseUri 'https://api.atlassian.com/ex/confluence/<cloudId>' -Username 'you@example.com' -Token $token -SpaceKey 'DOCS'
21+
Connect-Confluence -Site 'yoursite' -Username 'you@example.com' -Token $token -SpaceKey 'DOCS'
2122

2223
# Store several sites/accounts under explicit names and select per call.
23-
Connect-Confluence -ApiBaseUri 'https://api.atlassian.com/ex/confluence/<cloudId>' -Username 'you@example.com' -Token $token -Name 'sandbox'
24+
# If you already know the cloud ID, pass it directly with -CloudId to skip the lookup.
25+
Connect-Confluence -CloudId '<cloudId>' -Username 'you@example.com' -Token $token -Name 'sandbox'
2426
Get-ConfluenceSpace -Key 'DOCS' -Context 'sandbox'
2527

2628
###

‎src/functions/public/BlogPosts/Get-ConfluenceBlogPost.ps1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
function Get-ConfluenceBlogPost {
33
<#
44
.SYNOPSIS
5-
Get blog posts (read:page).
5+
Get blog posts (read:blogpost:confluence).
66
77
.DESCRIPTION
88
Returns a single blog post by id, the blog posts in a space, or all blog

0 commit comments

Comments
 (0)