Skip to content

Commit 08afb7d

Browse files
committed
run prettier on the docs
1 parent 9b1e622 commit 08afb7d

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

docs/source/contributor-guide/cloud-credential-providers.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ Implementations must be thread-safe.
8989

9090
The `mode` is the access intent for this credential request:
9191

92-
| Value | Used for |
93-
| ----------------- | ----------------------------------------------------------------------- |
94-
| `READ` | All native scan paths (raw Parquet, Iceberg). Comet today only sends READ. |
95-
| `WRITE` | Reserved for future native write paths (Iceberg writes, native INSERT). |
92+
| Value | Used for |
93+
| ------- | -------------------------------------------------------------------------- |
94+
| `READ` | All native scan paths (raw Parquet, Iceberg). Comet today only sends READ. |
95+
| `WRITE` | Reserved for future native write paths (Iceberg writes, native INSERT). |
9696

9797
The SPI does not promise that a `WRITE` credential is also read-capable; vendors that need
9898
read-during-write workflows (multipart-completion HEAD, Iceberg manifest reads on the write path,
@@ -113,19 +113,19 @@ The returned `CometCredentials` POJO carries:
113113

114114
The SPI follows the same shape as every other AWS-credential SPI in the JVM ecosystem:
115115

116-
| SPI | Method | Behavior |
117-
| ------------------------------------------- | -------------------------------------------- | ------------------------- |
118-
| AWS SDK v1 `AWSCredentialsProvider` | `getCredentials()` | returns or throws |
119-
| AWS SDK v2 `AwsCredentialsProvider` | `resolveCredentials()` | returns or throws |
120-
| Hadoop S3A `AWSCredentialsProvider` | `getCredentials()` | returns or throws |
121-
| Iceberg `VendedCredentialsProvider` | `resolveCredentials()` | returns or throws |
122-
| Iceberg `AwsClientFactory` | `s3()` | returns a configured client |
123-
| **Comet `CometCloudCredentialProvider`** | `getCredentialsForPath(bucket, path, mode)` | **returns or throws** |
116+
| SPI | Method | Behavior |
117+
| ---------------------------------------- | ------------------------------------------- | --------------------------- |
118+
| AWS SDK v1 `AWSCredentialsProvider` | `getCredentials()` | returns or throws |
119+
| AWS SDK v2 `AwsCredentialsProvider` | `resolveCredentials()` | returns or throws |
120+
| Hadoop S3A `AWSCredentialsProvider` | `getCredentials()` | returns or throws |
121+
| Iceberg `VendedCredentialsProvider` | `resolveCredentials()` | returns or throws |
122+
| Iceberg `AwsClientFactory` | `s3()` | returns a configured client |
123+
| **Comet `CometCloudCredentialProvider`** | `getCredentialsForPath(bucket, path, mode)` | **returns or throws** |
124124

125-
Chaining/fallback in the AWS world is a separate concern, composed *outside* the provider —
125+
Chaining/fallback in the AWS world is a separate concern, composed _outside_ the provider —
126126
e.g. AWS SDK v2's `AwsCredentialsProviderChain.builder().credentialsProviders(...)`, or the Hadoop
127127
S3A `fs.s3a.aws.credentials.provider` comma-separated list resolved by
128-
`AWSCredentialsProviderChain`. Each *individual* provider is atomic ("give me a credential or
128+
`AWSCredentialsProviderChain`. Each _individual_ provider is atomic ("give me a credential or
129129
fail"); a chain class composes them.
130130

131131
Comet's SPI keeps to this convention. We considered an alternative `Optional<CometCredentials>`
@@ -191,7 +191,7 @@ the Unix epoch.
191191
- Returning `null` is a contract violation; the native bridge surfaces it as a request failure.
192192
Implementations that want to defer to a default credential chain on a subset of paths should
193193
resolve the default chain themselves and return its credentials — see the worked pattern under
194-
*Why this SPI returns or throws* above.
194+
_Why this SPI returns or throws_ above.
195195

196196
#### Iceberg path: error message fidelity
197197

@@ -252,8 +252,8 @@ identical credentials.
252252
A vendor that wants to compose multiple credential sources (per-path STS for some prefixes, a
253253
catchall provider for others) does so inside their single provider implementation — same as how
254254
AWS SDK v1/v2 providers compose into `AwsCredentialsProviderChain` at the call site rather than
255-
exposing chain semantics through the individual provider contract. See *Why this SPI returns or
256-
throws* above for a worked example.
255+
exposing chain semantics through the individual provider contract. See _Why this SPI returns or
256+
throws_ above for a worked example.
257257

258258
## Threading and lifecycle
259259

0 commit comments

Comments
 (0)