doc: Add hyperlink for pydolphinscheduler
This commit is contained in:
Jay Chung
parent
d2b0b34cb0
commit
6e3bf435d6
|
|
@ -447,15 +447,15 @@ export default {
|
|||
children: [
|
||||
{
|
||||
title: 'Open API',
|
||||
link: '/en-us/docs/3.1.4/user_doc/guide/open-api.html',
|
||||
link: '/en-us/docs/3.1.4/user_doc/guide/api/open-api.html',
|
||||
},
|
||||
{
|
||||
title: 'PyDolphinScheduler',
|
||||
link: '/python/main/index.html',
|
||||
link: '/en-us/docs/3.1.4/user_doc/guide/api/pydolphinscheduler.html',
|
||||
},
|
||||
{
|
||||
title: 'Health Check',
|
||||
link: '/en-us/docs/3.1.4/user_doc/guide/healthcheck.html',
|
||||
link: '/en-us/docs/3.1.4/user_doc/guide/api/healthcheck.html',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
|
@ -1055,15 +1055,15 @@ export default {
|
|||
children: [
|
||||
{
|
||||
title: 'API调用',
|
||||
link: '/zh-cn/docs/3.1.4/user_doc/guide/open-api.html',
|
||||
link: '/zh-cn/docs/3.1.4/user_doc/guide/api/open-api.html',
|
||||
},
|
||||
{
|
||||
title: 'PyDolphinScheduler',
|
||||
link: '/python/main/index.html',
|
||||
link: '/zh-cn/docs/3.1.4/user_doc/guide/api/pydolphinscheduler.html',
|
||||
},
|
||||
{
|
||||
title: '健康检查',
|
||||
link: '/zh-cn/docs/3.1.4/user_doc/guide/healthcheck.html',
|
||||
link: '/zh-cn/docs/3.1.4/user_doc/guide/api/healthcheck.html',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
|
|
|||
|
|
@ -10,11 +10,11 @@ Generally, projects and processes are created through pages, but considering the
|
|||
|
||||
1. Log in to the scheduling system, click "Security", then click "Token manage" on the left, and click "Create token" to create a token.
|
||||
|
||||
|
||||
|
||||
|
||||
2. Select the "Expiration time" (Token validity time), select "User" (choose the specified user to perform the API operation), click "Generate token", copy the `Token` string, and click "Submit".
|
||||
|
||||
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ Generally, projects and processes are created through pages, but considering the
|
|||
|
||||
> Address：http://{API server ip}:12345/dolphinscheduler/swagger-ui/index.html?language=en_US&lang=en
|
||||
|
||||
|
||||
|
||||
|
||||
2. select a test API, the API selected for this test is `queryAllProjectList`
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ Generally, projects and processes are created through pages, but considering the
|
|||
token: The Token just generated
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
#### Create a Project
|
||||
|
||||
|
|
@ -44,15 +44,15 @@ This demonstrates how to use the calling api to create the corresponding project
|
|||
|
||||
By consulting the api documentation, configure the KEY as Accept and VALUE as the parameter of application/json in the headers of Postman.
|
||||
|
||||
|
||||
|
||||
|
||||
And then configure the required projectName and description parameters in Body.
|
||||
|
||||
|
||||
|
||||
|
||||
Check the post request result.
|
||||
|
||||
|
||||
|
||||
|
||||
The returned `msg` information is "success", indicating that we have successfully created the project through API.
|
||||
|
||||
|
|
@ -60,6 +60,6 @@ If you are interested in the source code of creating a project, please continue
|
|||
|
||||
### Appendix： The Source Code of Creating a Project
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# PyDolphinScheduler
|
||||
|
||||
PyDolphinScheduler is python API for Apache DolphinScheduler, which allow you definition your workflow by python code, aka workflow-as-codes.
|
||||
|
||||
For more information, please refer to [PyDolphinScheduler](https://dolphinscheduler.apache.org/python/main/)
|
||||
|
|
@ -10,11 +10,11 @@
|
|||
|
||||
1. 登录调度系统，点击 "安全中心"，再点击左侧的 "令牌管理"，点击 "令牌管理" 创建令牌。
|
||||
|
||||
|
||||
|
||||
|
||||
2. 选择 "失效时间" (Token 有效期)，选择 "用户" (以指定的用户执行接口操作)，点击 "生成令牌" ，拷贝 Token 字符串，然后点击 "提交" 。
|
||||
|
||||
|
||||
|
||||
|
||||
### 使用案例
|
||||
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
|
||||
> 地址：http://{api server ip}:12345/dolphinscheduler/swagger-ui/index.html?language=zh_CN&lang=cn
|
||||
|
||||
|
||||
|
||||
|
||||
2. 选一个测试的接口，本次测试选取的接口是：查询所有项目
|
||||
|
||||
|
|
@ -36,7 +36,7 @@
|
|||
token: 刚刚生成的 Token
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
#### 创建项目
|
||||
|
||||
|
|
@ -44,15 +44,15 @@
|
|||
|
||||
通过查阅 api 文档，在 Postman 的 Headers 中配置 KEY 为 Accept，VALUE 为 application/json 的参数。
|
||||
|
||||
|
||||
|
||||
|
||||
然后再 Body 中配置所需的 projectName 和 description 参数。
|
||||
|
||||
|
||||
|
||||
|
||||
检查 post 请求结果。
|
||||
|
||||
|
||||
|
||||
|
||||
返回 msg 信息为 "success"，说明我们已经成功通过 API 的方式创建了项目。
|
||||
|
||||
|
|
@ -60,6 +60,6 @@
|
|||
|
||||
### 附:创建项目源码
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
# PyDolphinScheduler
|
||||
|
||||
PyDolphinScheduler 是 Apache DolphinScheduler 的 Python API，它允许您通过 Python 代码定义您的工作流，也称为 workflow-as-codes。
|
||||
|
||||
更多信息请参考[PyDolphinScheduler](https://dolphinscheduler.apache.org/python/main/)
|
||||
|
||||
Loading…
Reference in New Issue