Document api usage - Githubissues

c0llab0rat0r commented 3 years ago

Change README to reference the /api/v3 endpoint
Add information about using authorization tokens

In testing this, I noticed that I was not getting this behavior from the api:

On success, you will receive a `HTTP 200` answer with a body containing `done: FULL_PATH_OF_BACKUP_FILE`.

I got a 200 Success and a backup file was generated, but no HTTP response body was included with a file name.

Is this a documentation defect (should the comment about the file name being returned be removed), or is it a bug (a file name should be returned, but isn't)?

takezoe commented 3 years ago

Thanks!

takezoe commented 3 years ago

By the way, looks like /api/v3 endpoint is mentioned in Securing backup endpoint section of README. https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin#securing-backup-endpoint

However, I think it's better to use /api/v3 endpoint in any cases. We may want to get rid of the redirection from /database/backup and the explanation in README.

gitbucket-plugins / gitbucket-h2-backup-plugin

Document api usage #32