Skip to content

Commit 5a66488

Browse files
docs: auto-generate provider documentation (#957)
1 parent 5311daa commit 5a66488

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
page_title: "minio_batch_job_template Data Source - terraform-provider-minio"
3+
subcategory: ""
4+
description: |-
5+
Returns a starter YAML template for a given MinIO batch job type. Calls GenerateBatchJobV2 (EOS-only API) and falls back to the SDK's bundled static template when the server does not advertise the endpoint.
6+
---
7+
8+
# minio_batch_job_template (Data Source)
9+
10+
Returns a starter YAML template for a given MinIO batch job type. Calls `GenerateBatchJobV2` (EOS-only API) and falls back to the SDK's bundled static template when the server does not advertise the endpoint.
11+
12+
## Example Usage
13+
14+
```terraform
15+
data "minio_batch_job_template" "replicate" {
16+
job_type = "replicate"
17+
}
18+
19+
resource "minio_batch_job" "migrate" {
20+
job_type = "replicate"
21+
job_yaml = data.minio_batch_job_template.replicate.yaml
22+
}
23+
```
24+
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Required
29+
30+
- `job_type` (String) Batch job type to generate a template for (e.g. `replicate`, `expire`, `keyrotate`).
31+
32+
### Read-Only
33+
34+
- `id` (String) The ID of this resource.
35+
- `source` (String) Where the template came from: `server` (via `GenerateBatchJobV2`) or `sdk` (bundled fallback).
36+
- `yaml` (String) YAML job-definition template.

docs/resources/batch_job.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ EOF
3131

3232
### Required
3333

34-
- `job_type` (String) Batch job type. One of `replicate`, `expire`, `keyrotate`.
34+
- `job_type` (String) Batch job type. The provider queries the server's supported types via `GetSupportedBatchJobTypes` at Create time and rejects values the server does not advertise. Typically one of `replicate`, `expire`, `keyrotate`.
3535
- `job_yaml` (String, Sensitive) YAML job definition for the batch operation.
3636

3737
### Optional

0 commit comments

Comments
 (0)