This is an automated email from the ASF dual-hosted git repository.
bowenliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new 0d3389c6fb [KYUUBI #6734] [DOC] add authentication example in REST API
docs
0d3389c6fb is described below
commit 0d3389c6fb1427a7176a501ec6a2a53296f2ca34
Author: Bowen Liang <[email protected]>
AuthorDate: Wed Oct 16 13:12:00 2024 +0800
[KYUUBI #6734] [DOC] add authentication example in REST API docs
# :mag: Description
## Issue References ๐
This pull request fixes #
## Describe Your Solution ๐ง
- add authentication example in REST API docs
## Types of changes :bookmark:
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
## Test Plan ๐งช
#### Behavior Without This Pull Request :coffin:
#### Behavior With This Pull Request :tada:
#### Related Unit Tests
---
# Checklist ๐
- [ ] This patch was not authored or co-authored using [Generative
Tooling](https://www.apache.org/legal/generative-tooling.html)
**Be nice. Be informative.**
Closes #6734 from bowenliang123/rest-doc-auth.
Closes #6734
f9ac9446d [Cheng Pan] Update docs/client/rest/rest_api.md
528e55e79 [Bowen Liang] update doc
371af8806 [Bowen Liang] update doc
e64a08245 [Bowen Liang] update doc
341e7e010 [Bowen Liang] update doc
Lead-authored-by: Bowen Liang <[email protected]>
Co-authored-by: Cheng Pan <[email protected]>
Signed-off-by: Bowen Liang <[email protected]>
---
docs/client/rest/rest_api.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/docs/client/rest/rest_api.md b/docs/client/rest/rest_api.md
index 0bd1316d2b..c12f12ac60 100644
--- a/docs/client/rest/rest_api.md
+++ b/docs/client/rest/rest_api.md
@@ -19,6 +19,16 @@
Note that: now the api version is v1 and the base uri is `/api/v1`.
+## Authentication
+
+REST API supports the [Basic
Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization#basic_authentication)
which relies on `Authorization` header in HTTP request.
+
+```
+Authorization: Basic <credentials>
+```
+
+The `<credentials>` value is the Base64 encoded string of `username:password`.
For example, in the case of a user `aladdin` with the password `opensesame`,
set the `Authorization` header to `Basic YWxhZGRpbjpvcGVuc2VzYW1l` as Base64
encoded `aladdin:opensesame`.
+
## Session Resource
### GET /sessions
