Skip to content

docs: document renaming a site #39

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

Merged
vigneshrajsb merged 1 commit into from
Oct 13, 2026
Merged

docs: document renaming a site #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions documentation-style-baseline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"schemaVersion": 3,
"updatedOn": "2026-10-09",
"updatedOn": "2026-10-12",
"references": {
"canonical": "ASD-STE100 Issue 9",
"canonicalRules": [
Expand Down Expand Up @@ -135,8 +135,8 @@
"/docs/features/cli": {
"file": "src/pages/docs/features/cli.mdx",
"profile": "asd-ste100",
"reviewedOn": "2026-10-09",
"sha256": "b874b693d8a1acd30209d3351b5a64d4799415e21d4e73844c812908aae1bd5d"
"reviewedOn": "2026-10-12",
"sha256": "5d5c2b5509c4423e79fb1725d96b5eb976b7ab2566b4463e69f735737ca752b4"
},
"/docs/features/cli-telemetry": {
"file": "src/pages/docs/features/cli-telemetry.mdx",
Expand Down Expand Up @@ -201,8 +201,8 @@
"/docs/features/sites": {
"file": "src/pages/docs/features/sites.mdx",
"profile": "asd-ste100",
"reviewedOn": "2026-10-09",
"sha256": "1b20228a0ac155a39926073b6d26128df720a59acb13c1463ca05cb000472ca8"
"reviewedOn": "2026-10-12",
"sha256": "5d0b69784c91e3931fd48c7d3fcf8559ae2339657e7cb95452f7d850d8218687"
},
"/docs/features/template-variables": {
"file": "src/pages/docs/features/template-variables.mdx",
Expand Down
3 changes: 2 additions & 1 deletion src/pages/docs/features/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,14 +236,15 @@ lfc sites create <file-or-dir> [--name <label>] [--visibility private|public] [-
lfc sites list [--mine | --public | --deleted] [--search <text>]
lfc sites get <id>
lfc sites update <id> <file-or-dir>
lfc sites rename <id> <name>
lfc sites visibility <id> private|public [--yes]
lfc sites extend <id> # extend expiration
lfc sites delete <id> --yes
lfc sites restore <id>
```

The CLI prints the site's `openUrl`.
Changing visibility keeps the Site ID and content URL.
Renaming or changing visibility keeps the Site ID and content URL.
After `delete`, the CLI shows the time until which you can restore the site.
`restore` keeps the Site ID and URL.
If a change returns `409`, fetch the site again before you retry.
Expand Down
9 changes: 7 additions & 2 deletions src/pages/docs/features/sites.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Administrator access does not give ownership rights.
| Private (default) | Only the owner | Only the owner |
| Public | Anyone with the URL, without signing in | Only the owner |

The owner can replace content, extend expiration, change visibility, delete the site, or restore a deleted site.
The owner can replace content, rename the site, extend expiration, change visibility, delete the site, or restore a deleted site.
Public content can contain copies that remain outside Lifecycle after you make the site private.
Sites has no email invitations or viewer or editor roles.

Expand All @@ -55,7 +55,9 @@ Sites has no email invitations or viewer or editor roles.
Search matches the site name or ID.
Search and pagination do not expose other users' private sites.

From an owned site's actions menu, you can replace content, change visibility, or delete it.
From an owned site's actions menu, you can replace content, rename it, change visibility, or delete it.
Renaming changes only the display name.
The site ID and content URL stay the same.
The visibility dialog requires confirmation before publication.
When you change visibility, the site ID and content URL stay the same.
New requests to a private site require owner access.
Expand Down Expand Up @@ -100,6 +102,7 @@ lfc sites list --mine
lfc sites list --public --search report
lfc sites get a1b2c3d4e5
lfc sites update a1b2c3d4e5 ./dist
lfc sites rename a1b2c3d4e5 "performance report"
lfc sites visibility a1b2c3d4e5 private --yes
lfc sites extend a1b2c3d4e5
lfc sites delete a1b2c3d4e5 --yes
Expand Down Expand Up @@ -165,6 +168,7 @@ A scope permits an operation only when the caller also has the required ownershi
| Delete a site | `DELETE /api/v2/sites/{siteId}` | `sites:write` |
| Replace content | `PUT /api/v2/sites/{siteId}/content` | `sites:write` |
| Extend expiration | `POST /api/v2/sites/{siteId}/extend` | `sites:write` |
| Rename a site | `PATCH /api/v2/sites/{siteId}` | `sites:write` |
| Change visibility | `PATCH /api/v2/sites/{siteId}/access` | `sites:write` |
| Restore a site | `POST /api/v2/sites/{siteId}/restore` | `sites:write` |

Expand All @@ -191,6 +195,7 @@ curl --fail --silent --show-error \
"${LIFECYCLE_URL}/api/v2/sites"
```

Renaming requires the JSON field `name` (1-255 characters) and accepts an optional `expectedAccessRevision`.
Visibility changes require JSON fields `visibility` and `expectedAccessRevision`.
For replacement, send `expectedAccessRevision` and `expectedContentRevision` as multipart fields.
Older replacement clients can also receive `409` after a concurrent change.
Expand Down
Loading