Skip to content

Cherry pick app api doc #743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tossmilestone wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Cherry pick app api doc #743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fec4d7
docs(api): add application api reference and openapi schema (#715)
tossmilestone Apr 30, 2026
53d4ee3
docs(api): remove app.k8s.io api from lifecycle documentation
tossmilestone May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/en/apis/advanced_apis/application/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
i18n:
title:
en: Application APIs
zh: 应用 API
---

# Application APIs

<Overview overviewHeaders={[]} />
20 changes: 20 additions & 0 deletions docs/en/apis/advanced_apis/application/lifecycle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
i18n:
title:
en: Application Lifecycle
zh: 应用生命周期
---

# Application Lifecycle

This section describes the APIs for managing the lifecycle of applications in the Alauda Container Platform.

<OpenAPIPath
path={[
'/acp/v1/kubernetes/{cluster_name}/namespaces/{namespace}/applications',
'/acp/v1/kubernetes/{cluster_name}/namespaces/{namespace}/applications/{name}',
'/acp/v1/kubernetes/{cluster_name}/namespaces/{namespace}/applications/{name}/rollback',
'/acp/v1/kubernetes/{cluster_name}/namespaces/{namespace}/applications/{name}/start',
'/acp/v1/kubernetes/{cluster_name}/namespaces/{namespace}/applications/{name}/stop'
]}
/>
20 changes: 20 additions & 0 deletions docs/en/apis/advanced_apis/application/management.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
i18n:
title:
en: Application Management Operations
zh: 应用管理操作
---

# Application Management Operations

This section describes management APIs for application snapshots, exports, and task executions.

<OpenAPIPath
path={[
'/acp/v1/kubernetes/{cluster_name}/namespaces/{namespace}/applications/{name}/snapshot',
'/acp/v1/kubernetes/{cluster}/namespaces/{namespace}/applications/{name}/chartpackage',
Comment thread
coderabbitai[bot] marked this conversation as resolved.
'/acp/v1/kubernetes/{cluster}/cronjobs/{namespace}/{name}/exec',
'/acp/v1/kubernetes/{cluster}/general-namespaces',
'/acp/v1/resources/{cluster}/resources'
]}
/>
19 changes: 19 additions & 0 deletions docs/en/apis/advanced_apis/application/query.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
i18n:
title:
en: Application Query and Resources
zh: 应用查询与资源
---

# Application Query and Resources

This section describes the APIs for querying application status, resource lists, and related topology information.

<OpenAPIPath
path={[
'/acp/v1/kubernetes/{cluster}/namespaces/{namespace}/applications/{name}',
Comment thread
tossmilestone marked this conversation as resolved.
'/acp/v1/kubernetes/{cluster_name}/namespaces/{namespace}/applications/{name}/address',
'/acp/v1/kubernetes/{cluster}/topology/{namespace}/{kind}/{name}',
'/acp/v1/resources/search/{list-url}',
]}
/>
Loading