Skip to content

Commit dc65566

Browse files
committed
full edit management topics(1) + bulk Note wording change
1 parent 8a9271f commit dc65566

File tree

17 files changed

+168
-143
lines changed

17 files changed

+168
-143
lines changed

api/v4/configuration/decryption-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,5 +107,5 @@ var builder = WebApplication.CreateBuilder(args);
107107
builder.Configuration.AddDecryption(new ExampleTextDecryptor(), NullLoggerFactory.Instance);
108108
```
109109

110-
> [!WARNING]
110+
> [!CAUTION]
111111
> Creating encryption algorithms is notoriously difficult. Use this only if you know what you are doing.

api/v4/management/cloud-foundry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ builder.Services.AddCloudFoundryActuator();
4848
```
4949

5050
> [!TIP]
51-
> It's recommended to use `AddAllActuators()` instead of adding individual actuators,
51+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
5252
> which enables individually turning them on/off at runtime via configuration.
5353
5454
### Cross Origin Resource Sharing

api/v4/management/dbmigrations.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
# Database Migrations
22

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.
44

55
> [!NOTE]
6-
> Please review Microsoft's [EF Core Migrations Overview](https://learn.microsoft.com/ef/core/managing-schemas/migrations) for more in-depth information.
6+
> For more detailed information, see [EF Core Migrations Overview](https://learn.microsoft.com/ef/core/managing-schemas/migrations) in the Microsoft documentation.
77
88
## Configure Settings
99

1010
The following table describes the configuration settings that you can apply to the endpoint.
1111
Each key must be prefixed with `Management:Endpoints:DbMigrations:`.
1212

1313
| 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` |
2020

2121
## Enable HTTP Access
2222

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.
2424
The default path is `/actuator/dbmigrations`.
2525

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.
2727

2828
To add the actuator to the service container and map its route, use the `AddDbMigrationsActuator` extension method.
2929

@@ -37,14 +37,14 @@ builder.Services.AddDbMigrationsActuator();
3737
```
3838

3939
> [!TIP]
40-
> It's recommended to use `AddAllActuators()` instead of adding individual actuators,
40+
> It is recommended that you use `AddAllActuators()` instead of adding individual actuators,
4141
> which enables individually turning them on/off at runtime via configuration.
4242
4343
## Sample Output
4444

4545
This endpoint returns a list of objects representing each registered `DbContext` along with its migrations, grouped by status (pending or applied).
4646

47-
The response will always be returned as JSON, like this:
47+
The response is always returned as JSON, as shown here:
4848

4949
```json
5050
{

api/v4/management/env.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ The following table describes the configuration settings that you can apply to t
88
Each key must be prefixed with `Management:Endpoints:Env:`.
99

1010
| 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" ]` |
1818

1919
[^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.
2020

2121
## Enable HTTP Access
2222

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.
2424
The default path is `/actuator/env`.
2525

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.
2727

2828
To add the actuator to the service container and map its route, use the `AddEnvironmentActuator` extension method.
2929

@@ -36,15 +36,15 @@ var builder = WebApplication.CreateBuilder(args);
3636
builder.Services.AddEnvironmentActuator();
3737
```
3838

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,
4141
> which enables individually turning them on/off at runtime via configuration.
4242
4343
## Sample Output
4444

4545
This endpoint returns a list of objects representing information from `IConfiguration`.
4646

47-
The response will always be returned as JSON, like this:
47+
The response is always returned as JSON, like this:
4848

4949
```json
5050
{

0 commit comments

Comments
 (0)