Document fields and parameters added to support cloud backup #2506
Conversation
📝 WalkthroughWalkthroughThe pull request introduces enhancements to the Supervisor API documentation, focusing on backup-related endpoints and models. The changes expand the backup information by adding new fields like Changes
Sequence DiagramsequenceDiagram
participant Client
participant SupervisorAPI
participant BackupSystem
Client->>SupervisorAPI: Request Backup Creation
alt Full Backup
Client->>SupervisorAPI: POST /backups/new/full
else Partial Backup
Client->>SupervisorAPI: POST /backups/new/partial
end
SupervisorAPI->>BackupSystem: Initiate Backup
BackupSystem-->>SupervisorAPI: Generate Backup
SupervisorAPI-->>Client: Return Backup Details (size, locations)
This sequence diagram illustrates the high-level flow of backup creation through the Supervisor API, showing how a client can request either a full or partial backup, and receive detailed information about the created backup. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🧰 Additional context used🪛 Markdownlint (0.37.0)docs/api/supervisor/endpoints.md879-879: null (MD036, no-emphasis-as-heading) 885-885: null (MD036, no-emphasis-as-heading) 997-997: null (MD036, no-emphasis-as-heading) 1003-1003: null (MD036, no-emphasis-as-heading) 🔇 Additional comments (11)docs/api/supervisor/models.md (3)
The additions to the Backup model are clear and comprehensive:
The changes to the Backup details model align well with the Backup model changes:
The Mount model updates are well structured:
docs/api/supervisor/endpoints.md (8)
The backup response fields are clearly documented with examples showing:
Also applies to: 823-827
The backup creation endpoint documentation:
Also applies to: 861-862, 866-872
The backup upload endpoint documentation:
🧰 Tools🪛 Markdownlint (0.37.0)879-879: null (MD036, no-emphasis-as-heading) 885-885: null (MD036, no-emphasis-as-heading)
The partial backup endpoint documentation:
The backup download endpoint documentation:
🧰 Tools🪛 Markdownlint (0.37.0)997-997: null (MD036, no-emphasis-as-heading) 1003-1003: null (MD036, no-emphasis-as-heading)
The backup delete endpoint documentation:
The backup restore endpoint documentation:
The partial restore endpoint documentation:
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Proposed change
Document the fields and parameters added to Supervisor's API in support of the cloud backup work. Additionally fixes some small gaps in the backup response model documentation I noticed.
This is catch-up after a number of PRs to Supervisor. I'm actually going to link the Supervisor client library PRs rather then Supervisor ones as they are easier to review since they match the API changes and almost nothing else. Whereas the Supervisor PRs include a lot more then the API changes. They also link back to the corresponding Supervisor PRs for reviewing there as well:
Type of change
Additional information
Summary by CodeRabbit
Backup,Backup details, andMount.