This is an automated email from the ASF dual-hosted git repository.
wangdan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pegasus-website.git
The following commit(s) were added to refs/heads/master by this push:
new ac09fb43 update api doc (#123)
ac09fb43 is described below
commit ac09fb43fbfa250f6c5d71a6401972c59439dd7c
Author: Samunroyu <[email protected]>
AuthorDate: Thu Nov 6 18:16:01 2025 +0800
update api doc (#123)
---
_docs/en/api/api.md | 25 +++++++++++++++++++++++++
_docs/zh/api/api.md | 12 ++++++------
2 files changed, 31 insertions(+), 6 deletions(-)
diff --git a/_docs/en/api/api.md b/_docs/en/api/api.md
new file mode 100644
index 00000000..77e36fee
--- /dev/null
+++ b/_docs/en/api/api.md
@@ -0,0 +1,25 @@
+---
+permalink: api/index.html
+---
+
+This page introduces the user interfaces provided by the Pegasus service.
Clients can build secondary wrappers on top of these service interfaces.
+In most cases, you only need to learn how to interact with Pegasus via the
[Client Documentation](/clients).
+
+Pegasus currently supports several interface protocols:
+
+## Pegasus Protocol
+
+This is the protocol used by our clients to interact with Pegasus servers.
Through this protocol we expose:
+
+- Single-row idempotent atomic operations, such as `set/get/del/ttl`...
+- Single-row non-idempotent atomic operations, such as
`check_and_mutate/incr`...
+- Multi-row idempotent atomic operations, such as
`multiset/multiget/multidel`...
+- Scan operations with filtering, such as `hash_scan/unordered_scan`...
+
+## Redis Protocol
+
+We support the Redis protocol on top of the Pegasus protocol via the Pegasus
Redis Proxy component.
+You can read [Redis Adaptation](/redis) to learn more.
+
+Since the Redis interface provides GEO support, we also support geospatial
query capabilities through it.
+You can read [GEO Support](/geo) to learn more.
\ No newline at end of file
diff --git a/_docs/zh/api/api.md b/_docs/zh/api/api.md
index 1a0bb08d..6be7ca94 100644
--- a/_docs/zh/api/api.md
+++ b/_docs/zh/api/api.md
@@ -2,14 +2,14 @@
permalink: api/index.html
---
-这里介绍Pegasus服务所提供的用户接口。客户端可以在我们的服务接口上做二次封装。
-通常你只需要通过 [客户端文档](/clients) 学习如何与Pegasus交互。
+这里介绍 Pegasus 服务所提供的用户接口。客户端可以在我们的服务接口上做二次封装。
+通常你只需要通过 [客户端文档](/clients) 学习如何与 Pegasus 交互。
-当前Pegasus支持几种接口协议：
+当前 Pegasus 支持几种接口协议：
## Pegasus 协议
-这也是我们的客户端与Pegasus服务端交互所使用的协议。我们通过该协议暴露了
+这也是我们的客户端与 Pegasus 服务端交互所使用的协议。我们通过该协议暴露了
- 单行幂等原子操作，如 set/get/del/ttl...
@@ -21,8 +21,8 @@ permalink: api/index.html
## Redis 协议
-我们通过Pegasus Redis Proxy这一组件在Pegasus协议之上支持了Redis协议。
+我们通过 Pegasus Redis Proxy 这一组件在 Pegasus 协议之上支持了 Redis 协议。
你可以阅读 [Redis适配](/redis) 了解更多。
-因为Redis接口提供了GEO支持，我们也借此支持了地理信息查询的功能。
+因为 Redis 接口提供了 GEO 支持，我们也借此支持了地理信息查询的功能。
你可以阅读 [GEO支持](/geo) 了解更多。
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
