Skip to content

Commit ce19b30

Browse files
committed
Document environment_grouped in app show
Add documentation for the application configuration fields returned by the App Show endpoint and CLI. The API reference now documents the App Show response, describing `environment` (user-set env vars) and `environment_grouped` (env vars grouped by origin with `user` and `service` keys). The CLI command docs (epinio app show) were updated to note the `-o json` output includes these fields and how to use `environment_grouped` to distinguish user vs service-provided variables. The configurations guide gained a short note pointing users to use the CLI JSON output or the API `?grouped=true` query to view environment variables by origin.
1 parent ba8f931 commit ce19b30

3 files changed

Lines changed: 17 additions & 1 deletion

File tree

docs/references/api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,10 @@ The endpoints are documented in the [OpenAPI Spec](https://www.openapis.org/) fo
2222
__Make sure__ you change to the Epinio release you have deployed.
2323

2424
There are various tools you can use to easily browse the API (e.g. https://editor.swagger.io/). If you have a Golang environment set up locally, you may find it easier to run `make swagger swagger-serve` from the root of the Epinio repository.
25+
26+
### App Show response (GET application)
27+
28+
The App Show endpoint returns application details including `configuration`. The configuration includes:
29+
30+
- **`environment`** — Environment variables set by the user (key-value map).
31+
- **`environment_grouped`** — Environment variables grouped by origin (user-set vs service-provided). Has the same structure as `GET .../environment?grouped=true`, with `user` and `service` keys each containing an `EnvVariableMap`. Use this when you need to distinguish user-defined variables from those injected by bound services.

docs/references/commands/cli/app/epinio_app_show.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ doc-persona: [epinio-developer, epinio-operator]
99
---
1010
## epinio app show
1111

12-
Describe the named application
12+
Describe the named application. Shows details such as status, instances, routes, bound configurations, and environment.
13+
14+
With `-o json`, the response includes application `configuration` with:
15+
16+
- **`environment`** — User-set environment variables (key-value map).
17+
- **`environment_grouped`** — Environment variables grouped by origin (`user` and `service`), same structure as [epinio app env show](env/epinio_app_env_show.md) when using the API with `?grouped=true`. Use this to tell user-defined variables apart from those injected by bound services.
1318

1419
```
1520
epinio app show NAME [flags]

docs/references/configurations.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,7 @@ filesystem of that application, namely:
7575

7676
The application can now read these files and use their content to connect to the configuration,
7777
authenticate, and then use it.
78+
79+
### Viewing environment variables by origin
80+
81+
Environment variables from bound configurations are also exposed as application environment variables. To see user-set variables separately from service-provided ones (from bound configurations), use [epinio app show](commands/cli/app/epinio_app_show.md) with `-o json` and read `configuration.environment_grouped`, or use the API's environment endpoint with `?grouped=true`.

0 commit comments

Comments
 (0)