Skip to content

Commit c32bc9c

Browse files
committed
align docs format
1 parent f15cc90 commit c32bc9c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

mkdocs/docs/configuration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -384,15 +384,15 @@ Legacy OAuth2 Properties will be removed in PyIceberg 1.0 in place of pluggable
384384

385385
The RESTCatalog supports pluggable authentication via the `auth` configuration block. This allows you to specify which how the access token will be fetched and managed for use with the HTTP requests to the RESTCatalog server. The authentication method is selected by setting the `auth.type` property, and additional configuration can be provided as needed for each method.
386386

387-
##### Supported Authentication Types
387+
###### Supported Authentication Types
388388

389389
- `noop`: No authentication (no Authorization header sent).
390390
- `basic`: HTTP Basic authentication.
391391
- `oauth2`: OAuth2 client credentials flow.
392392
- `legacyoauth2`: Legacy OAuth2 client credentials flow (Deprecated and will be removed in PyIceberg 1.0.0)
393393
- `custom`: Custom authentication manager (requires `auth.impl`).
394394

395-
##### Configuration Properties
395+
###### Configuration Properties
396396

397397
The `auth` block is structured as follows:
398398

@@ -408,7 +408,7 @@ catalog:
408408
impl: <custom_class_path> # Only for custom auth
409409
```
410410

411-
**Property Reference:**
411+
###### Property Reference
412412

413413
| Property | Required | Description |
414414
|------------------|----------|-------------------------------------------------------------------------------------------------|
@@ -418,16 +418,16 @@ catalog:
418418
| `auth.oauth2` | If type is `oauth2` | Block containing OAuth2 configuration (see below). |
419419
| `auth.custom` | If type is `custom` | Block containing configuration for the custom AuthManager. |
420420

421-
##### Examples
421+
###### Examples
422422

423-
**No Authentication:**
423+
No Authentication:
424424

425425
```yaml
426426
auth:
427427
type: noop
428428
```
429429

430-
**Basic Authentication:**
430+
Basic Authentication:
431431

432432
```yaml
433433
auth:
@@ -437,7 +437,7 @@ auth:
437437
password: mypass
438438
```
439439

440-
**OAuth2 Authentication:**
440+
OAuth2 Authentication:
441441

442442
```yaml
443443
auth:
@@ -451,7 +451,7 @@ auth:
451451
expires_in: 3600 # (optional) fallback if server does not provide
452452
```
453453

454-
**Custom Authentication:**
454+
Custom Authentication:
455455

456456
```yaml
457457
auth:
@@ -462,7 +462,7 @@ auth:
462462
property2: value2
463463
```
464464

465-
##### Notes
465+
###### Notes
466466

467467
- If `auth.type` is `custom`, you **must** specify `auth.impl` with the full class path to your custom AuthManager.
468468
- If `auth.type` is not `custom`, specifying `auth.impl` is not allowed.

0 commit comments

Comments
 (0)