Commit Graph

17 Commits

Author SHA1 Message Date
fwang12
0fdf145e29 [KYUUBI #4639] Support to specify confOverlay when executing statement with RESTful API
### _Why are the changes needed?_

As title.

With this pr, customer can execute SCALA code with `confOverlay`.
```
kyuubi.operation.language=SCALA
```
execute PYTHON code with
```
kyuubi.operation.language=PYTHON
```
### _How was this patch tested?_
- [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4639 from turboFei/init_scala.

Closes #4639

cdf828f9a [fwang12] add ut
f4f2bc883 [fwang12] doc
2fe8a1659 [fwang12] save
f840cb4d9 [fwang12] conf overlay
eb49537ea [fwang12] conf overlay

Authored-by: fwang12 <fwang12@ebay.com>
Signed-off-by: fwang12 <fwang12@ebay.com>
2023-03-30 19:13:49 +08:00
maruilei
6d8fe6c381
[KYUUBI #4627] [Docs] Fix a typo in rest_api.md.
### _Why are the changes needed?_

`GET /batches/{batchId}` should be `GET /batches/${batchId}`

Affected versions 1.6/1.7/master

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4627 from merrily01/master-typo.

Closes #4627

ac386f640 [maruilei] [Docs] Fix a typo in rest_api.md.

Authored-by: maruilei <maruilei@58.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-03-28 18:14:39 +08:00
fwang12
47376c9ff2 [KYUUBI #3739][FOLLOWUP][REST] Remove unused parameters in SessionsResource rest docs
### _Why are the changes needed?_

as title.

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4521 from turboFei/rest_docs.

Closes #3739

589237ca6 [fwang12] save
8e7d9bec6 [fwang12] final
35b67ba1e [fwang12] doc
40163311f [fwang12] save
5711d3d72 [fwang12] fix
bab07902f [fwang12] fix ut
d58c2753a [fwang12] save
989eaffd5 [fwang12] remove
2960602bc [fwang12] remove outdate docs

Authored-by: fwang12 <fwang12@ebay.com>
Signed-off-by: fwang12 <fwang12@ebay.com>
2023-03-16 17:04:02 +08:00
fwang12
86dc59c4cf [KYUUBI #3876][FOLLOWUP] Update the rest api docs for open session response
### _Why are the changes needed?_

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4396 from turboFei/rest_doc.

Closes #3876

de23e30e5 [fwang12] nit
41bd4ca4e [fwang12] save:

Authored-by: fwang12 <fwang12@ebay.com>
Signed-off-by: fwang12 <fwang12@ebay.com>
2023-02-24 08:27:23 +08:00
fwang12
e647cc910c
[KYUUBI #4119][FOLLOWUP] Add app start time for batch api docs
### _Why are the changes needed?_

#4119 follow up

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4365 from turboFei/app_start.

Closes #4119

3cf7e7a7 [fwang12] add app start time

Authored-by: fwang12 <fwang12@ebay.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-02-18 22:38:33 +08:00
liangbowen
b6a1a376bf [KYUUBI #4199][Followup] Reformat rest-api.md with markdown style rules
### _Why are the changes needed?_

- Reformat markdown file `rest-api.md` with changes from  (https://github.com/apache/kyuubi/pull/4199) in with  ( https://github.com/apache/kyuubi/pull/4200)

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4210 from bowenliang123/4199-followup.

Closes #4199

f66cf8ee [liangbowen] reformat changes in markdown files

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-01-30 12:38:44 +08:00
liangbowen
69d625a1be [KYUUBI #4200] [Improvement] [Docs] Introduce Markdown formatting with spotless-maven-plugin and flexmark for docs
### _Why are the changes needed?_

- to consolidate styles in markdown files from manual written or auto-generated
- apply markdown formatting rules with flexmark from [spotless-maven-plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven#markdown) to *.md files in `/docs`
- use `flexmark` to format markdown generation in `TestUtils` of common module used by `AllKyuubiConfiguration` and `KyuubiDefinedFunctionSuite`, as the same way in `FlexmarkFormatterFunc ` of `spotless-maven-plugin` using with `COMMONMARK` as `FORMATTER_EMULATION_PROFILE` (https://github.com/diffplug/spotless/blob/maven/2.30.0/lib/src/flexmark/java/com/diffplug/spotless/glue/markdown/FlexmarkFormatterFunc.java)
- using `flexmark` of` 0.62.2`, as the last version requiring Java 8+ (checked from pom file and bytecode version)

```
<markdown>
    <includes>
        <include>docs/**/*.md</include>
    </includes>
    <flexmark></flexmark>
</markdown>
```

- Changes applied to markdown doc files,
  -  no style change or breakings in built docs by `make html`
  - removal all the first blank in licences and comments to conform markdown style rules
  - tables regenerated by flexmark following as in [GitHub Flavored Markdown](https://help.github.com/articles/organizing-information-with-tables/) (https://github.com/vsch/flexmark-java/wiki/Extensions#tables)

### _How was this patch tested?_
- [x] regenerate docs using `make html` successfully and check all the markdown pages available
- [x] regenerate `settings.md` and `functions.md` by `AllKyuubiConfiguration` and `KyuubiDefinedFunctionSuite`, and pass the checks by both themselves and spotless check via `dev/reformat`
- [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4200 from bowenliang123/markdown-formatting.

Closes #4200

1eeafce4 [liangbowen] revert minor changes in AllKyuubiConfiguration
4f892857 [liangbowen] use flexmark in markdown doc generation
8c978abd [liangbowen] changes on markdown files
a9190556 [liangbowen] apply markdown formatting rules with `spotless-maven-plugin` to markdown files with in `/docs`

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-01-30 11:14:41 +08:00
liangbowen
cf0c495e5c [KYUUBI #4199] [DOC] Add REST API doc for POST /batches with uploading resource
### _Why are the changes needed?_

- add docs in REST API for POST /batches with uploading resource, which was introduced in #4106 .

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

![image](https://user-images.githubusercontent.com/1935105/215376995-64a88606-61eb-4d45-8578-3de7ead84b26.png)

Closes #4199 from bowenliang123/rest-batchupload-doc.

Closes #4199

957249d4 [liangbowen] add doc for POST /batches (with uploading resource)

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-01-30 10:48:24 +08:00
liangbowen
2563e3c3ad
[KYUUBI #3982] [FOLLWUP] Add REST Api doc for refresh/user_defaults_conf of AdminResource
### _Why are the changes needed?_

- add  doc for`POST /admin/refresh/user_defaults_conf` REST Api , which introduced in #3982

### _How was this patch tested?_
- [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4077 from bowenliang123/3982-followup.

Closes #3982

a6acb389 [liangbowen] add REST api doc of `POST /admin/refresh/user_defaults_conf`

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
2023-01-04 14:14:35 +08:00
Luning Wang
373835536e
[KYUUBI #3039][DOCS] Add operation resource REST docs
### _Why are the changes needed?_
Add operation resource REST docs

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3709 from deadwind4/operation-rest-doc.

Closes #3039

437685c40 [Luning Wang] Fix descriptions of action
eb9557d41 [Luning Wang] Fix descriptions
60d038a43 [Luning Wang] [KYUUBI #3039][DOCS] Add operation resource REST docs

Authored-by: Luning Wang <wang4luning@gmail.com>
Signed-off-by: Kent Yao <yao@apache.org>
2022-11-09 15:47:07 +08:00
Fei Wang
14b9fd5e75 [KYUUBI #3722] Set default parameters for BatchesResource in server side
### _Why are the changes needed?_

Set the same default values for BatchesResource in server side.
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3722 from turboFei/batch_user_defaults.

Closes #3722

496e61a55 [Fei Wang] default in server side

Authored-by: Fei Wang <fwang12@ebay.com>
Signed-off-by: Fei Wang <fwang12@ebay.com>
2022-10-30 17:53:31 +08:00
Luning Wang
0f51279cb3 [KYUUBI #3703][DOCS] Fix typo in localLog REST API
### _Why are the changes needed?_
Fix typo in localLog of batch REST API

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3704 from deadwind4/batch-typo.

Closes #3703

d89390d9 [Luning Wang] [KYUUBI #3703][DOCS] Fix typo in localLog REST API

Authored-by: Luning Wang <wang4luning@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2022-10-29 10:37:55 +00:00
Tianlin Liao
d8fc3ec867 [KYUUBI #3688] add rest_api and kyuubi-admin docs for admin delete/list engine operation
### _Why are the changes needed?_

close #3688

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate
<img width="1413" alt="image" src="https://user-images.githubusercontent.com/21362040/197667408-679b940d-d217-473a-8131-7fe106faa8c5.png">
<img width="1370" alt="image" src="https://user-images.githubusercontent.com/21362040/197667453-2ad673f8-286c-4031-a804-8d354ce688b2.png">
<img width="1593" alt="image" src="https://user-images.githubusercontent.com/21362040/197670699-e06654fc-5b31-44a5-88da-da3ec157250b.png">

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3689 from lightning-L/doc.

Closes #3688

7292596bc [Tianlin Liao] fix wording
cd5657d86 [Tianlin Liao] [KYUUBI #3688] add rest_api and kyuubi-admin docs for admin delete/list engine operation

Authored-by: Tianlin Liao <tiliao@ebay.com>
Signed-off-by: Fei Wang <fwang12@ebay.com>
2022-10-25 19:40:51 +08:00
Luning Wang
9d0b6909db
[KYUUBI #3621][DOCS] Add a hint in create batch REST api
### _Why are the changes needed?_

Add a hint in creating batch REST API.

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3622 from deadwind4/create-batch-rest-doc.

Closes #3621

0d1e6764 [Luning Wang] [KYUUBI #3621][DOCS] Add a hint in create batch REST api

Authored-by: Luning Wang <wang4luning@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2022-10-19 00:25:09 +08:00
Luning Wang
797957629d
[KYUUBI #3611][DOCS] Add session resource REST docs
### _Why are the changes needed?_
Add session resource REST docs in `rest_api.md`

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3642 from deadwind4/session-rest-doc.

Closes #3611

3d8e5e6b [Luning Wang] Fix wrong description
8a1372a5 [Luning Wang] [KYUUBI #3611][DOCS] Add session resource REST docs

Authored-by: Luning Wang <wang4luning@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2022-10-19 00:22:07 +08:00
Fei Wang
9cb8041dbd [KYUUBI #3076][Subtask][#3039] Add the docs for rest api - Batch Resource
### _Why are the changes needed?_

Add the docs for batch resource rest api.
Close #3076

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate
![image](https://user-images.githubusercontent.com/6757692/178957570-b0b9b006-a9a0-413d-bf74-c9c744d1fd50.png)

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3075 from turboFei/rest_api.

Closes #3076

970498e6 [Fei Wang] Cap
445fde21 [Fei Wang] nit
4b0306df [Fei Wang] refactor
b4a5a74f [Fei Wang] add rest api docs

Authored-by: Fei Wang <fwang12@ebay.com>
Signed-off-by: Fei Wang <fwang12@ebay.com>
2022-07-15 10:46:46 +08:00
Kent Yao
9060bf2284
[KYUUBI #3040] [Subtask][#3039] Build the skeleton of client side documentation
### _Why are the changes needed?_

As a subtask of #3039, this PR aims to build the skeleton of client side documentation

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate
![image](https://user-images.githubusercontent.com/8326978/178221566-6781eee5-8e0b-4821-b24d-0b17624276dc.png)

![image](https://user-images.githubusercontent.com/8326978/178221729-81b000d8-def6-45ba-87dd-9bfff46b5974.png)

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3041 from yaooqinn/3040.

Closes #3040

754d8a07 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of client side documentation
b574e10d [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of client side documentation
721e00c5 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of client side documentation
93fe8c42 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of client side documentation
b9606c94 [Kent Yao] [KYUUBI #3040] [Subtask][#3039] Build the skeleton of client side documentation

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
2022-07-12 11:03:44 +08:00