feat: add GitOps API documentation (#347)

tossmilestone · web-flow · commit 3f35c6f6068c · 2025-11-21T17:24:25.000+08:00
Signed-off-by: Xiaoxi He &lt;xxhe@alauda.io&gt;
diff --git a/docs/en/apis/advanced_apis/gitops/applications.mdx b/docs/en/apis/advanced_apis/gitops/applications.mdx
@@ -0,0 +1,15 @@
+---
+weight: 20
+---
+
+# Application
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applications" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applications/{name}" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applications/{name}/events" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applications/{name}/refresh" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applications/{name}/sync" />
diff --git a/docs/en/apis/advanced_apis/gitops/applicationsets.mdx b/docs/en/apis/advanced_apis/gitops/applicationsets.mdx
@@ -0,0 +1,27 @@
+---
+weight: 30
+---
+
+# ApplicationSet
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/applications" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/applications/{app_name}" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/applications/{app_name}/sync" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/events" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/prometheusrules" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/prometheusrules/{rule_name}" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/refresh" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/sync" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/applicationsets/{name}/topology" />
diff --git a/docs/en/apis/advanced_apis/gitops/core.mdx b/docs/en/apis/advanced_apis/gitops/core.mdx
@@ -0,0 +1,13 @@
+---
+weight: 10
+---
+
+# Core
+
+<OpenAPIPath path="/gitops/v1/gql" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/unifiedapps" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/repository/apps" />
+
+<OpenAPIPath path="/gitops/v1/project/{project}/repository/refs" />
diff --git a/docs/en/apis/advanced_apis/gitops/index.mdx b/docs/en/apis/advanced_apis/gitops/index.mdx
@@ -0,0 +1,4 @@
+
+# GitOps APIs
+
+<Overview overviewHeaders={[]} />
diff --git a/docs/shared/openapis/gitops-api.json b/docs/shared/openapis/gitops-api.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
++
 +# GitOps APIs
++
 +<Overview overviewHeaders={[]} />