Skip to content

docs: document backup API endpoints based on code#5172

Draft
Copilot wants to merge 2 commits intov3from
copilot/document-backups-in-code
Draft

docs: document backup API endpoints based on code#5172
Copilot wants to merge 2 commits intov3from
copilot/document-backups-in-code

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 24, 2026

The backup API docs only covered StartBackup, RestoreBackup, and ListLocations. This PR fills in the remaining endpoints from backup.proto, locations.proto, restores.proto, and artifacts.proto.

New documentation files

  • manage-locations.mdAddLocation, ChangeLocation, RemoveLocation, TestLocationConfig (filesystem & S3 examples, force-remove, config test)
  • schedule-backup.mdScheduleBackup, ListScheduledBackups, ChangeScheduledBackup, RemoveScheduledBackup (cron, mode descriptions, retention)
  • list-artifacts.mdListArtifacts, DeleteArtifact (with remove_files), ListArtifactCompatibleServices, ListPitrTimeranges, GetLogs (backup job)
  • list-restores.mdListRestores (with status values), GetLogs (restore job)

Updated

  • overview.md — Restructured into sections (Backup Locations, On-Demand and Scheduled Backups, Backup Artifacts, Restore) linking to all pages.

  • API Docs updated


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@it-percona-cla
Copy link
Copy Markdown
Contributor

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Co-authored-by: catalinaadam <94133018+catalinaadam@users.noreply.github.com>
Agent-Logs-Url: https://github.com/percona/pmm/sessions/ab01d791-b5d4-430e-bfcf-8b39700d3b5a
Copilot AI changed the title [WIP] Document backups in code docs: document backup API endpoints based on code Mar 24, 2026
Copilot AI requested a review from catalinaadam March 24, 2026 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants