This is an automated email from the ASF dual-hosted git repository.
xuba pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/amoro.git
The following commit(s) were added to refs/heads/master by this push:
new 965a6bfd6 [AMORO-3945][DOCS] Add docs for REST API (#3944)
965a6bfd6 is described below
commit 965a6bfd60cde1630ffecc6f86178e7f653b3bf1
Author: Fei Wang <[email protected]>
AuthorDate: Sat Nov 15 05:11:54 2025 -0800
[AMORO-3945][DOCS] Add docs for REST API (#3944)
docs
combine
---
docs/user-guides/rest-api.md | 45 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 45 insertions(+)
diff --git a/docs/user-guides/rest-api.md b/docs/user-guides/rest-api.md
new file mode 100644
index 000000000..727870354
--- /dev/null
+++ b/docs/user-guides/rest-api.md
@@ -0,0 +1,45 @@
+---
+title: "REST API"
+url: rest-api
+aliases:
+ - "user-guides/rest-api"
+menu:
+ main:
+ parent: User Guides
+ weight: 600
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+# REST API
+
+## Accessing Swagger UI
+
+Access the Swagger UI at:
+
+```
+http://<host>:<port>/#/openapi-ui
+```
+
+You can also view the OpenAPI specification YAML in the repository at
`amoro-ams/src/main/resources/openapi/openapi.yaml`, or use the [Swagger
Editor](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/apache/amoro/master/amoro-ams/src/main/resources/openapi/openapi.yaml)
online.
+
+## Building the OpenAPI SDK
+
+Build the OpenAPI SDK using Maven:
+
+```bash
+./mvnw clean package -pl amoro-openapi-sdk -am -Popenapi-sdk
+```
