Skip to content

Commit c7f49c9

Browse files
SplatcrafterSplatcrafter
committed
Align table formatting across Spring Boot documentation for consistency and readability.
1 parent 58fbcfa commit c7f49c9

4 files changed

Lines changed: 49 additions & 49 deletions

File tree

‎docs/spring-boot/actuator.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ Add Spring Boot Actuator to your project:
1919

2020
## Available Components
2121

22-
| Component | Endpoint | Description |
23-
|-----------|----------|-------------|
24-
| Health Indicator | `/actuator/health` | Reports UP/DOWN status for all DataFixer domains |
25-
| Info Contributor | `/actuator/info` | Adds DataFixer metadata to the info endpoint |
26-
| Custom Endpoint | `/actuator/datafixers` | Dedicated endpoint for DataFixer management |
22+
| Component | Endpoint | Description |
23+
|------------------|------------------------|--------------------------------------------------|
24+
| Health Indicator | `/actuator/health` | Reports UP/DOWN status for all DataFixer domains |
25+
| Info Contributor | `/actuator/info` | Adds DataFixer metadata to the info endpoint |
26+
| Custom Endpoint | `/actuator/datafixers` | Dedicated endpoint for DataFixer management |
2727

2828
---
2929

@@ -115,11 +115,11 @@ GET /actuator/health
115115

116116
### Health Status Semantics
117117

118-
| Status | Meaning |
119-
|--------|---------|
120-
| `UP` | All DataFixers operational |
121-
| `DOWN` | At least one DataFixer failed |
122-
| `UNKNOWN` | No DataFixers registered |
118+
| Status | Meaning |
119+
|-----------|-------------------------------|
120+
| `UP` | All DataFixers operational |
121+
| `DOWN` | At least one DataFixer failed |
122+
| `UNKNOWN` | No DataFixers registered |
123123

124124
### Kubernetes Integration
125125

@@ -245,10 +245,10 @@ management:
245245

246246
### Operations
247247

248-
| HTTP Method | Path | Description |
249-
|-------------|------|-------------|
250-
| GET | `/actuator/datafixers` | Summary of all domains |
251-
| GET | `/actuator/datafixers/{domain}` | Details for specific domain |
248+
| HTTP Method | Path | Description |
249+
|-------------|---------------------------------|-----------------------------|
250+
| GET | `/actuator/datafixers` | Summary of all domains |
251+
| GET | `/actuator/datafixers/{domain}` | Details for specific domain |
252252

253253
### Summary Response
254254

‎docs/spring-boot/configuration.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ All properties use the prefix `aether.datafixers`.
88

99
## Property Summary
1010

11-
| Property | Type | Default | Description |
12-
|----------|------|---------|-------------|
13-
| `enabled` | boolean | `true` | Enable/disable auto-configuration |
14-
| `default-format` | enum | `GSON` | Default serialization format |
15-
| `default-current-version` | Integer | `null` | Fallback version for all domains |
16-
| `domains.<name>.*` | Map | `{}` | Per-domain configuration |
17-
| `actuator.*` | object | — | Actuator settings |
18-
| `metrics.*` | object | — | Metrics settings |
11+
| Property | Type | Default | Description |
12+
|---------------------------|---------|---------|-----------------------------------|
13+
| `enabled` | boolean | `true` | Enable/disable auto-configuration |
14+
| `default-format` | enum | `GSON` | Default serialization format |
15+
| `default-current-version` | Integer | `null` | Fallback version for all domains |
16+
| `domains.<name>.*` | Map | `{}` | Per-domain configuration |
17+
| `actuator.*` | object | — | Actuator settings |
18+
| `metrics.*` | object | — | Metrics settings |
1919

2020
---
2121

‎docs/spring-boot/index.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ The `aether-datafixers-spring-boot-starter` module provides seamless integration
44

55
## Key Features
66

7-
| Feature | Description |
8-
|---------|-------------|
9-
| **Auto-Configuration** | Automatic setup of DataFixer beans from `DataFixerBootstrap` definitions |
10-
| **Fluent Migration API** | High-level `MigrationService` with builder pattern |
11-
| **Multi-Domain Support** | Independent DataFixer instances for different data types |
12-
| **Actuator Integration** | Health indicators, info contributors, and custom endpoints |
13-
| **Micrometer Metrics** | Success/failure counters, timing, and version span tracking |
14-
| **Async Execution** | Non-blocking migration with `CompletableFuture` support |
7+
| Feature | Description |
8+
|--------------------------|--------------------------------------------------------------------------|
9+
| **Auto-Configuration** | Automatic setup of DataFixer beans from `DataFixerBootstrap` definitions |
10+
| **Fluent Migration API** | High-level `MigrationService` with builder pattern |
11+
| **Multi-Domain Support** | Independent DataFixer instances for different data types |
12+
| **Actuator Integration** | Health indicators, info contributors, and custom endpoints |
13+
| **Micrometer Metrics** | Success/failure counters, timing, and version span tracking |
14+
| **Async Execution** | Non-blocking migration with `CompletableFuture` support |
1515

1616
---
1717

@@ -138,13 +138,13 @@ The Spring Boot starter organizes components into the following layers:
138138

139139
## Auto-Configuration Classes
140140

141-
| Configuration Class | Purpose |
142-
|---------------------|---------|
143-
| `AetherDataFixersAutoConfiguration` | Main entry point, imports all sub-configurations |
144-
| `DynamicOpsAutoConfiguration` | Creates `GsonOps` and `JacksonOps` beans |
145-
| `DataFixerAutoConfiguration` | Creates `AetherDataFixer` beans from bootstraps |
146-
| `MigrationServiceAutoConfiguration` | Creates the `MigrationService` bean |
147-
| `ActuatorAutoConfiguration` | Creates health indicators, info contributors, and endpoints |
141+
| Configuration Class | Purpose |
142+
|-------------------------------------|-------------------------------------------------------------|
143+
| `AetherDataFixersAutoConfiguration` | Main entry point, imports all sub-configurations |
144+
| `DynamicOpsAutoConfiguration` | Creates `GsonOps` and `JacksonOps` beans |
145+
| `DataFixerAutoConfiguration` | Creates `AetherDataFixer` beans from bootstraps |
146+
| `MigrationServiceAutoConfiguration` | Creates the `MigrationService` bean |
147+
| `ActuatorAutoConfiguration` | Creates health indicators, info contributors, and endpoints |
148148

149149
---
150150

@@ -167,20 +167,20 @@ aether:
167167
168168
## Requirements
169169
170-
| Requirement | Version |
171-
|-------------|---------|
172-
| Java | 17+ |
173-
| Spring Boot | 3.0+ |
174-
| Spring Framework | 6.0+ |
170+
| Requirement | Version |
171+
|------------------|---------|
172+
| Java | 17+ |
173+
| Spring Boot | 3.0+ |
174+
| Spring Framework | 6.0+ |
175175
176176
### Optional Dependencies
177177
178-
| Dependency | Purpose |
179-
|------------|---------|
178+
| Dependency | Purpose |
179+
|--------------------------------|--------------------------------------------------------|
180180
| `spring-boot-starter-actuator` | Health indicators, info contributors, custom endpoints |
181-
| `micrometer-core` | Migration metrics recording |
182-
| `gson` | JSON support via `GsonOps` |
183-
| `jackson-databind` | JSON support via `JacksonOps` |
181+
| `micrometer-core` | Migration metrics recording |
182+
| `gson` | JSON support via `GsonOps` |
183+
| `jackson-databind` | JSON support via `JacksonOps` |
184184

185185
---
186186

‎docs/spring-boot/multi-domain.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Use multi-domain setups when:
1919

2020
```
2121
┌─────────────────────────────────────────────────────────────┐
22-
│ DataFixerRegistry │
22+
│ DataFixerRegistry │
2323
├─────────────────────────────────────────────────────────────┤
2424
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
2525
│ │ "game" │ │ "user" │ │ "world" │ │
@@ -30,7 +30,7 @@ Use multi-domain setups when:
3030
│
3131
▼
3232
┌─────────────────────────────────────────────────────────────┐
33-
│ MigrationService │
33+
│ MigrationService │
3434
│ .migrate(data).usingDomain("game").from(100).to(200) │
3535
└─────────────────────────────────────────────────────────────┘
3636
```

0 commit comments

Comments
 (0)