Modified backup API documentation to reflect v2 changes #306
Conversation
|
Saurabh Kishore Mistry seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
|
|
||
| <%= | ||
| available_since('15.2.0') do | ||
| <%= available_since('19.3.0') do |
There was a problem hiding this comment.
We should add 15.2.0 with the link https://api.gocd.org/15.2.0/#backups to the list below for users to refer to v1.
There was a problem hiding this comment.
Comment incorporated.
| @@ -1,20 +1,35 @@ | |||
| ## Create a backup | |||
| ## Schedules backup asynchronously. | |||
There was a problem hiding this comment.
For consistency, I think we should call this heading Schedule Backup (and without the . at the end)
There was a problem hiding this comment.
Comment incorporated.
| Returns an empty response body with a response code 202 (Accepted) and location header containing the link to be polled for checking the status of the backup. | ||
| </p> | ||
|
|
||
| `GET /go/api/backups/:scheduled_backup_id` |
There was a problem hiding this comment.
I think the GET endpoint should be in a sidebar heading of its own, since it's a separate endpoint.
I would also prefer to call the parameter :backup_id instead of :scheduled_backup_id, since we can use an ID to also GET older backups.
There was a problem hiding this comment.
Comment incorporated.
In this check-in, modified backup API documentation per #5781
README file was missing some instructions to get API docs running locally. Added those details.
Modified ServerBackup object details to reflect the recent v2 changes
Modified API doc to reflect request, response payload, header details as per v2 changes