Skip to content

Commit ae8c8fd

Browse files
authored
Merge pull request #450 from Peefy/docs-0.10-api-documents
docs: add full v0.10 API documents
2 parents 8af0bce + 26d274a commit ae8c8fd

File tree

8 files changed

+58
-6
lines changed

8 files changed

+58
-6
lines changed

docs/reference/xlang-api/lua-api.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 10
3+
---
4+
5+
# Lus API
6+
7+
The official [Lua KCL package](https://github.com/kcl-lang/lib/tree/main/lua) has not been released yet. Issues and PRs are welcome!
8+
9+
## Quick Start
10+
11+
```lua
12+
local result, err = kcl_lib.exec_program({k_filename_list=["schema.k"]})
13+
```

docs/user_docs/getting-started/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,12 @@ In summary, KCL boasts the following characteristics:
5151
- **Quick modeling**: [Schema](https://kcl-lang.github.io/docs/reference/lang/tour#schema)-centric configuration types and modular abstraction enable rapid and efficient modeling.
5252
- **Stability**: Configuration stability built on [static type system](https://kcl-lang.github.io/docs/reference/lang/tour/#type-system), [constraints](https://kcl-lang.github.io/docs/reference/lang/tour/#validation), and [rules](https://kcl-lang.github.io/docs/reference/lang/tour#rule).
5353
- **Scalability**: KCL's automatic merge mechanism for isolated configuration blocks promotes high scalability.
54-
- **Fast automation**: KCL offers a gradient automation scheme encompassing [CRUD APIs](https://kcl-lang.github.io/docs/reference/lang/tour/#kcl-cli-variable-override), [multilingual SDKs](https://kcl-lang.github.io/docs/reference/xlang-api/overview), and [language plugins](https://kcl-lang.github.io/docs/reference/plugin/overview)
54+
- **Fast automation**: KCL offers a gradient automation scheme encompassing [CRUD APIs](https://kcl-lang.github.io/docs/reference/lang/tour/#kcl-cli-variable-override), [multilingual APIs](https://kcl-lang.github.io/docs/reference/xlang-api/overview), and [language plugins](https://kcl-lang.github.io/docs/reference/plugin/overview)
5555
- **High performance**: Leveraging Rust, C, and LLVM, KCL achieves high compilation and runtime performance, supporting compilation to native code and WebAssembly.
5656
- **API affinity**: KCL natively supports API specifications like JsonSchema, OpenAPI, Kubernetes CRDs, Kubernetes YAML, Terraform provider schema and etc.
5757
- **Development friendly**: KCL provides a rich suite of language tools (format, lint, test, vet, doc) and [IDE extensions](https://kcl-lang.github.io/docs/tools/Ide/) for a smooth development experience.
5858
- **Safety and maintainability**: KCL's domain-oriented nature avoids system-level functions, minimizing noise, security risks, and maintenance overhead.
59-
- **Rich multi-language SDK**: SDKs for Rust, Go, Python, Java, Node.js and REST APIs cater to diverse scenarios and application use cases.
59+
- **Rich multi-language SDK**: SDKs for [Rust](https://kcl-lang.github.io/docs/reference/xlang-api/rust-api), [Go](https://kcl-lang.github.io/docs/reference/xlang-api/go-api), [Python](https://kcl-lang.github.io/docs/reference/xlang-api/python-api), [Java](https://kcl-lang.github.io/docs/reference/xlang-api/java-api), [.NET](https://kcl-lang.github.io/docs/reference/xlang-api/dotnet-api), [Node.js](https://kcl-lang.github.io/docs/reference/xlang-api/nodejs-api), [Kotlin](https://kcl-lang.github.io/docs/reference/xlang-api/kotlin-api), [Swift](https://kcl-lang.github.io/docs/reference/xlang-api/swift-api), [C](https://kcl-lang.github.io/docs/reference/xlang-api/c-api), [C++](https://kcl-lang.github.io/docs/reference/xlang-api/cpp-api), [WASM](https://www.kcl-lang.io/docs/reference/xlang-api/wasm-api) and [REST](https://www.kcl-lang.io/docs/reference/xlang-api/rest-api) APIs cater to diverse scenarios and application use cases.
6060
- **Kubernetes integrations**: External mutation and validation plugins including [Kustomize KCL Plugin](https://github.com/kcl-lang/kustomize-kcl), [Helm KCL Plugin](https://github.com/kcl-lang/helm-kcl), [KPT KCL SDK](https://github.com/kcl-lang/kpt-kcl-sdk), [Kubectl KCL Plugin](https://github.com/kcl-lang/kubectl-kcl) or [Crossplane KCL Function](https://github.com/kcl-lang/crossplane-kcl) to separate data and logic.
6161
- **Production-ready**: KCL has been successfully deployed in production environments at Ant Group for platform engineering and automation.
6262

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 10
3+
---
4+
5+
# Lus API
6+
7+
[Lua KCL API](https://github.com/kcl-lang/lib/tree/main/lua) 正在开发当中,尚未正式发布。欢迎提交 Issues 或者 PRs 参与共建!
8+
9+
## 快速开始
10+
11+
```lua
12+
local result, err = kcl_lib.exec_program({k_filename_list=["schema.k"]})
13+
```

i18n/zh-CN/docusaurus-plugin-content-docs/current/user_docs/getting-started/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ KCL 试图提供独立于运行时的可编程性,不在本地提供线程和
5757
- **API 亲和**:原生支持 [OpenAPI](https://github.com/kcl-lang/kcl-openapi)、 Kubernetes CRD, Kubernetes YAML 等 API 生态规范
5858
- **开发友好**[语言工具](https://kcl-lang.io/docs/tools/cli/kcl/) (Format,Lint,Test,Vet,Doc 等)、 [IDE 插件](https://github.com/kcl-lang/vscode-kcl) 构建良好的研发体验
5959
- **安全可控**:面向领域,不原生提供线程、IO 等系统级功能,低噪音,低安全风险,易维护,易治理
60-
- **多语言 SDK**[Go](https://kcl-lang.io/docs/reference/xlang-api/go-api)[Python](https://kcl-lang.io/docs/reference/xlang-api/python-api)[Java](https://kcl-lang.io/docs/reference/xlang-api/java-api)[REST API](https://kcl-lang.io/docs/reference/xlang-api/rest-api) 满足不同场景和应用使用需求
60+
- **多语言 SDK**[Rust](https://kcl-lang.github.io/docs/reference/xlang-api/rust-api), [Go](https://kcl-lang.github.io/docs/reference/xlang-api/go-api), [Python](https://kcl-lang.github.io/docs/reference/xlang-api/python-api), [Java](https://kcl-lang.github.io/docs/reference/xlang-api/java-api), [.NET](https://kcl-lang.github.io/docs/reference/xlang-api/dotnet-api), [Node.js](https://kcl-lang.github.io/docs/reference/xlang-api/nodejs-api), [Kotlin](https://kcl-lang.github.io/docs/reference/xlang-api/kotlin-api), [Swift](https://kcl-lang.github.io/docs/reference/xlang-api/swift-api), [C](https://kcl-lang.github.io/docs/reference/xlang-api/c-api), [C++](https://kcl-lang.github.io/docs/reference/xlang-api/cpp-api), [WASM](https://www.kcl-lang.io/docs/reference/xlang-api/wasm-api)[REST API](https://kcl-lang.io/docs/reference/xlang-api/rest-api) 满足不同场景和应用使用需求
6161
- **生态集成**:通过 [Kustomize KCL 插件](https://github.com/kcl-lang/kustomize-kcl), [Helm KCL 插件](https://github.com/kcl-lang/helm-kcl), [KPT KCL SDK](https://github.com/kcl-lang/kpt-kcl-sdk), [Kubectl KCL 插件](https://github.com/kcl-lang/kubectl-kcl) 或者 [Crossplane KCL 函数](https://github.com/kcl-lang/crossplane-kcl) 分离数据和逻辑,并直接编辑或校验资源
6262
- **生产可用**:广泛应用在蚂蚁集团平台工程及自动化的生产环境实践中
6363

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 10
3+
---
4+
5+
# Lus API
6+
7+
[Lua KCL API](https://github.com/kcl-lang/lib/tree/main/lua) 正在开发当中,尚未正式发布。欢迎提交 Issues 或者 PRs 参与共建!
8+
9+
## 快速开始
10+
11+
```lua
12+
local result, err = kcl_lib.exec_program({k_filename_list=["schema.k"]})
13+
```

i18n/zh-CN/docusaurus-plugin-content-docs/version-0.10/user_docs/getting-started/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ KCL 试图提供独立于运行时的可编程性,不在本地提供线程和
5757
- **API 亲和**:原生支持 [OpenAPI](https://github.com/kcl-lang/kcl-openapi)、 Kubernetes CRD, Kubernetes YAML 等 API 生态规范
5858
- **开发友好**[语言工具](https://kcl-lang.io/docs/tools/cli/kcl/) (Format,Lint,Test,Vet,Doc 等)、 [IDE 插件](https://github.com/kcl-lang/vscode-kcl) 构建良好的研发体验
5959
- **安全可控**:面向领域,不原生提供线程、IO 等系统级功能,低噪音,低安全风险,易维护,易治理
60-
- **多语言 SDK**[Go](https://kcl-lang.io/docs/reference/xlang-api/go-api)[Python](https://kcl-lang.io/docs/reference/xlang-api/python-api)[Java](https://kcl-lang.io/docs/reference/xlang-api/java-api)[REST API](https://kcl-lang.io/docs/reference/xlang-api/rest-api) 满足不同场景和应用使用需求
60+
- **多语言 SDK**[Rust](https://kcl-lang.github.io/docs/reference/xlang-api/rust-api), [Go](https://kcl-lang.github.io/docs/reference/xlang-api/go-api), [Python](https://kcl-lang.github.io/docs/reference/xlang-api/python-api), [Java](https://kcl-lang.github.io/docs/reference/xlang-api/java-api), [.NET](https://kcl-lang.github.io/docs/reference/xlang-api/dotnet-api), [Node.js](https://kcl-lang.github.io/docs/reference/xlang-api/nodejs-api), [Kotlin](https://kcl-lang.github.io/docs/reference/xlang-api/kotlin-api), [Swift](https://kcl-lang.github.io/docs/reference/xlang-api/swift-api), [C](https://kcl-lang.github.io/docs/reference/xlang-api/c-api), [C++](https://kcl-lang.github.io/docs/reference/xlang-api/cpp-api), [WASM](https://www.kcl-lang.io/docs/reference/xlang-api/wasm-api)[REST API](https://kcl-lang.io/docs/reference/xlang-api/rest-api) 满足不同场景和应用使用需求
6161
- **生态集成**:通过 [Kustomize KCL 插件](https://github.com/kcl-lang/kustomize-kcl), [Helm KCL 插件](https://github.com/kcl-lang/helm-kcl), [KPT KCL SDK](https://github.com/kcl-lang/kpt-kcl-sdk), [Kubectl KCL 插件](https://github.com/kcl-lang/kubectl-kcl) 或者 [Crossplane KCL 函数](https://github.com/kcl-lang/crossplane-kcl) 分离数据和逻辑,并直接编辑或校验资源
6262
- **生产可用**:广泛应用在蚂蚁集团平台工程及自动化的生产环境实践中
6363

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 10
3+
---
4+
5+
# Lus API
6+
7+
The official [Lua KCL package](https://github.com/kcl-lang/lib/tree/main/lua) has not been released yet. Issues and PRs are welcome!
8+
9+
## Quick Start
10+
11+
```lua
12+
local result, err = kcl_lib.exec_program({k_filename_list=["schema.k"]})
13+
```

versioned_docs/version-0.10/user_docs/getting-started/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,12 @@ In summary, KCL boasts the following characteristics:
5151
- **Quick modeling**: [Schema](https://kcl-lang.github.io/docs/reference/lang/tour#schema)-centric configuration types and modular abstraction enable rapid and efficient modeling.
5252
- **Stability**: Configuration stability built on [static type system](https://kcl-lang.github.io/docs/reference/lang/tour/#type-system), [constraints](https://kcl-lang.github.io/docs/reference/lang/tour/#validation), and [rules](https://kcl-lang.github.io/docs/reference/lang/tour#rule).
5353
- **Scalability**: KCL's automatic merge mechanism for isolated configuration blocks promotes high scalability.
54-
- **Fast automation**: KCL offers a gradient automation scheme encompassing [CRUD APIs](https://kcl-lang.github.io/docs/reference/lang/tour/#kcl-cli-variable-override), [multilingual SDKs](https://kcl-lang.github.io/docs/reference/xlang-api/overview), and [language plugins](https://kcl-lang.github.io/docs/reference/plugin/overview)
54+
- **Fast automation**: KCL offers a gradient automation scheme encompassing [CRUD APIs](https://kcl-lang.github.io/docs/reference/lang/tour/#kcl-cli-variable-override), [multilingual APIs](https://kcl-lang.github.io/docs/reference/xlang-api/overview), and [language plugins](https://kcl-lang.github.io/docs/reference/plugin/overview)
5555
- **High performance**: Leveraging Rust, C, and LLVM, KCL achieves high compilation and runtime performance, supporting compilation to native code and WebAssembly.
5656
- **API affinity**: KCL natively supports API specifications like JsonSchema, OpenAPI, Kubernetes CRDs, Kubernetes YAML, Terraform provider schema and etc.
5757
- **Development friendly**: KCL provides a rich suite of language tools (format, lint, test, vet, doc) and [IDE extensions](https://kcl-lang.github.io/docs/tools/Ide/) for a smooth development experience.
5858
- **Safety and maintainability**: KCL's domain-oriented nature avoids system-level functions, minimizing noise, security risks, and maintenance overhead.
59-
- **Rich multi-language SDK**: SDKs for Rust, Go, Python, Java, Node.js and REST APIs cater to diverse scenarios and application use cases.
59+
- **Rich multi-language SDK**: SDKs for [Rust](https://kcl-lang.github.io/docs/reference/xlang-api/rust-api), [Go](https://kcl-lang.github.io/docs/reference/xlang-api/go-api), [Python](https://kcl-lang.github.io/docs/reference/xlang-api/python-api), [Java](https://kcl-lang.github.io/docs/reference/xlang-api/java-api), [.NET](https://kcl-lang.github.io/docs/reference/xlang-api/dotnet-api), [Node.js](https://kcl-lang.github.io/docs/reference/xlang-api/nodejs-api), [Kotlin](https://kcl-lang.github.io/docs/reference/xlang-api/kotlin-api), [Swift](https://kcl-lang.github.io/docs/reference/xlang-api/swift-api), [C](https://kcl-lang.github.io/docs/reference/xlang-api/c-api), [C++](https://kcl-lang.github.io/docs/reference/xlang-api/cpp-api), [WASM](https://www.kcl-lang.io/docs/reference/xlang-api/wasm-api) and [REST](https://www.kcl-lang.io/docs/reference/xlang-api/rest-api) APIs cater to diverse scenarios and application use cases.
6060
- **Kubernetes integrations**: External mutation and validation plugins including [Kustomize KCL Plugin](https://github.com/kcl-lang/kustomize-kcl), [Helm KCL Plugin](https://github.com/kcl-lang/helm-kcl), [KPT KCL SDK](https://github.com/kcl-lang/kpt-kcl-sdk), [Kubectl KCL Plugin](https://github.com/kcl-lang/kubectl-kcl) or [Crossplane KCL Function](https://github.com/kcl-lang/crossplane-kcl) to separate data and logic.
6161
- **Production-ready**: KCL has been successfully deployed in production environments at Ant Group for platform engineering and automation.
6262

0 commit comments

Comments
 (0)