Skip to content

Deployment history UI #345

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.

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
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified src/pages/_images/api-mesh-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/_images/deployment-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions src/pages/mesh/advanced/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,14 @@ aio api-mesh:get [FILE] [-i] [--json] [--help]

`--json` outputs the file as JSON.

`--active` retrieves the active mesh (as indicated in the [developer console UI](../basic/create-mesh.md#deployment-history)). This is the most recent successfully deployed mesh.

If you have not successfully deployed a mesh, the `--active` flag will return the following error:

```terminal
No active deployment found for mesh. Check the details and try again or try without the --active flag. RequestId: ${global.requestId}
```

`--help` provides information on the specified command.

### Example
Expand Down
20 changes: 20 additions & 0 deletions src/pages/mesh/basic/create-mesh.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,3 +316,23 @@ On the API Mesh Details screen, you can use the tabs to view different segments
To download a copy of your mesh file, click the **Download Mesh Schema** button at the top of the API Mesh Details screen.

![download mesh](../../_images/download-mesh-schema.png)

### Mesh configuration

On the **Active Config** tab, you can view the mesh configuration for the currently active mesh. If you have not successfully deployed a mesh, the **Config** tab displays the latest mesh configuration file that you uploaded.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need to make a similar statement (If you have not successfully deployed a mesh...) in the description of the --active flag?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amolina-adobe if no mesh is has been successfully deployed, what does the --active flag return?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No active deployment found for mesh. Check the details and try again or try without the --active flag. RequestId: ${global.requestId}


### Deployment history

On the Deployment History tab, you can view the history of your mesh deployments.

![deployment history](../../_images/deployment-history.png)

The deployment history includes the following information:

- **Active** - A green checkmark indicates the currently active mesh, which is the most recent successfully deployed mesh.
- **Version** - A unique alphanumeric string that indicates the version of your mesh.
- **Deployed On** - The time and date when this version of the mesh was created or updated.
- **Deployed By** - The user who deployed this mesh version.
- **Status** - The deployment status, such as`Success`, `Provisioning`, or `Failed`.
- **Logs** - An icon that you can click to download any errors or other exceptions that occurred when deploying the mesh. If there are no errors, the icon will not appear.
- **Config** - An icon that you can click to download the mesh configuration file for that specific deployment.
10 changes: 10 additions & 0 deletions src/pages/mesh/release/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ To use the latest enhancements, update your CLI to the latest version:
aio plugins:install @adobe/aio-cli-plugin-api-mesh
```

## July 29, 2025

This release contains the following changes to API Mesh:

### Enhancements

- Added a new user interface to the [developer console](../basic/create-mesh.md#deployment-history) that allows you to view the deployment history for your mesh.

- Added an `--active` flag to the [`aio api-mesh:get`](../advanced/index.md#aio-api-meshget) command that allows you to retrieve the most recent successfully deployed mesh.

## June 24, 2025

This release contains the following changes to API Mesh:
Expand Down