You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/v4/management/dbmigrations.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,29 @@
1
1
# Database Migrations
2
2
3
-
The Steeltoe Database Migrations endpoint exposes information about database migrations that are available to an application's data source that has been built with Entity Framework Core (EF Core). EF Core migrations give developers the ability to update an application's database schema while staying consistent with the application's data model without removing any existing data.
3
+
The Steeltoe Database Migrations endpoint exposes information about database migrations that are available to an application's data source that has been built with Entity Framework Core (EF Core). EF Core migrations give developers the ability to update an application's database schema while staying consistent with the application's data model, and without removing any existing data.
> For more detailed information, see [EF Core Migrations Overview](https://learn.microsoft.com/ef/core/managing-schemas/migrations)in the Microsoft documentation.
7
7
8
8
## Configure Settings
9
9
10
10
The following table describes the configuration settings that you can apply to the endpoint.
11
11
Each key must be prefixed with `Management:Endpoints:DbMigrations:`.
12
12
13
13
| Key | Description | Default |
14
-
| --- | --- | --- |
15
-
|`Enabled`| Whether the endpoint is enabled.|`true`|
16
-
|`ID`| The unique ID of the endpoint.|`dbmigrations`|
17
-
|`Path`| The relative path at which the endpoint is exposed.| same as `ID`|
18
-
|`RequiredPermissions`| Permissions required to access the endpoint, when running on Cloud Foundry.|`Restricted`|
19
-
|`AllowedVerbs`| An array of HTTP verbs the endpoint is exposed at.|`GET`|
14
+
| --- | -----------|------- |
15
+
|`Enabled`| Whether the endpoint is enabled |`true`|
16
+
|`ID`| The unique ID of the endpoint |`dbmigrations`|
17
+
|`Path`| The relative path at which the endpoint is exposed | same as `ID`|
18
+
|`RequiredPermissions`| Permissions required to access the endpoint when running on Cloud Foundry |`Restricted`|
19
+
|`AllowedVerbs`| An array of HTTP verbs at which the endpoint is exposed |`GET`|
20
20
21
21
## Enable HTTP Access
22
22
23
-
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting together with the `Path` setting described in the preceding section.
23
+
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section.
24
24
The default path is `/actuator/dbmigrations`.
25
25
26
-
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the overall steps required to enable HTTP access to endpoints in an ASP.NET Core application.
26
+
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.
27
27
28
28
To add the actuator to the service container and map its route, use the `AddDbMigrationsActuator` extension method.
Copy file name to clipboardExpand all lines: api/v4/management/env.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,22 +8,22 @@ The following table describes the configuration settings that you can apply to t
8
8
Each key must be prefixed with `Management:Endpoints:Env:`.
9
9
10
10
| Key | Description | Default |
11
-
| --- | --- | --- |
12
-
|`Enabled`| Whether the endpoint is enabled.|`true`|
13
-
|`ID`| The unique ID of the endpoint.|`env`|
14
-
|`Path`| The relative path at which the endpoint is exposed.| same as `ID`|
15
-
|`RequiredPermissions`| Permissions required to access the endpoint, when running on Cloud Foundry.|`Restricted`|
16
-
|`AllowedVerbs`| An array of HTTP verbs the endpoint is exposed at.|`GET`|
17
-
|`KeysToSanitize`| An array of keys to sanitize.[^1]|`[ "password", "secret", "key", "token", ".*credentials.*", "vcap_services" ]`|
11
+
| --- | -----------|------- |
12
+
|`Enabled`| Whether the endpoint is enabled |`true`|
13
+
|`ID`| The unique ID of the endpoint |`env`|
14
+
|`Path`| The relative path at which the endpoint is exposed | same as `ID`|
15
+
|`RequiredPermissions`| Permissions required to access the endpoint, when running on Cloud Foundry |`Restricted`|
16
+
|`AllowedVerbs`| An array of HTTP verbs at which the endpoint is exposed |`GET`|
17
+
|`KeysToSanitize`| An array of keys to sanitize [^1]|`[ "password", "secret", "key", "token", ".*credentials.*", "vcap_services" ]`|
18
18
19
19
[^1]: A key can be a simple string that the property must end with, or a regular expression. A case-insensitive match is always performed. Use a single-element empty string to disable sanitization.
20
20
21
21
## Enable HTTP Access
22
22
23
-
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting together with the `Path` setting described in the preceding section.
23
+
The URL path to the endpoint is computed by combining the global `Management:Endpoints:Path` setting with the `Path` setting described in the preceding section.
24
24
The default path is `/actuator/env`.
25
25
26
-
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the overall steps required to enable HTTP access to endpoints in an ASP.NET Core application.
26
+
See the [Exposing Endpoints](./using-endpoints.md#exposing-endpoints) and [HTTP Access](./using-endpoints.md#http-access) sections for the steps required to enable HTTP access to endpoints in an ASP.NET Core application.
27
27
28
28
To add the actuator to the service container and map its route, use the `AddEnvironmentActuator` extension method.
29
29
@@ -36,15 +36,15 @@ var builder = WebApplication.CreateBuilder(args);
36
36
builder.Services.AddEnvironmentActuator();
37
37
```
38
38
39
-
> [!TIP]
40
-
> It's recommended to use `AddAllActuators()` instead of adding individual actuators,
39
+
> [!NOTE]
40
+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
41
41
> which enables individually turning them on/off at runtime via configuration.
42
42
43
43
## Sample Output
44
44
45
45
This endpoint returns a list of objects representing information from `IConfiguration`.
46
46
47
-
The response will always be returned as JSON, like this:
47
+
The response is always returned as JSON, like this:
0 commit comments