Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(Documentation) Use OpenAPI-compatible type names in docs #1469

Merged
merged 1 commit into from
Oct 30, 2023
Merged

(Documentation) Use OpenAPI-compatible type names in docs #1469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- (Feature) Member Memory Reservation
- (Documentation) Update ArangoDeploymentReplication and ArangoLocalStorage CR auto-generated docs
- (Feature) Add ArangoMember Message and extend ArangoMember CRD
- (Documentation) Use OpenAPI-compatible type names in docs

## [1.2.34](https://github.com/arangodb/kube-arangodb/tree/1.2.34) (2023-10-16)
- (Bugfix) Fix make manifests-crd-file command
Expand Down
32 changes: 16 additions & 16 deletions docs/api/ArangoBackup.V1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

## Spec

### .spec.backoff.iterations: int
### .spec.backoff.iterations: integer

Iterations defines number of iterations before reaching MaxDelay. Default to 5

[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L31)

### .spec.backoff.max_delay: int
### .spec.backoff.max_delay: integer

MaxDelay defines maximum delay in seconds. Default to 600

[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L29)

### .spec.backoff.max_iterations: int
### .spec.backoff.max_iterations: integer

MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)

[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L33)

### .spec.backoff.min_delay: int
### .spec.backoff.min_delay: integer

MinDelay defines minimum delay in seconds. Default to 30

Expand Down Expand Up @@ -72,13 +72,13 @@ This field is **immutable**: can't be changed after backup creation

[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L77)

### .spec.lifetime: int64
### .spec.lifetime: integer

Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".

[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L47)

### .spec.options.allowInconsistent: bool
### .spec.options.allowInconsistent: boolean

AllowInconsistent flag for Backup creation request.
If this value is set to true, backup is taken even if we are not able to acquire lock.
Expand All @@ -89,7 +89,7 @@ This field is **immutable**: can't be changed after backup creation

[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L66)

### .spec.options.timeout: float32
### .spec.options.timeout: number

Timeout for Backup creation request in seconds.

Expand Down Expand Up @@ -139,17 +139,17 @@ This field is **immutable**: can't be changed after backup creation

## Status

### .status.available: bool
### .status.available: boolean

Available Determines if we can restore from ArangoBackup

[Code Reference](/pkg/apis/backup/v1/backup_status.go#L36)

### .status.backoff.iterations: int
### .status.backoff.iterations: integer

[Code Reference](/pkg/apis/backup/v1/backup_status_backoff.go#L30)

### .status.backup.downloaded: bool
### .status.backup.downloaded: boolean

Downloaded Determines if ArangoBackup has been downloaded.

Expand All @@ -159,31 +159,31 @@ Downloaded Determines if ArangoBackup has been downloaded.

[Code Reference](/pkg/apis/backup/v1/backup_status.go#L56)

### .status.backup.imported: bool
### .status.backup.imported: boolean

[Code Reference](/pkg/apis/backup/v1/backup_status.go#L67)

### .status.backup.keys: []string
### .status.backup.keys: array

[Code Reference](/pkg/apis/backup/v1/backup_status.go#L70)

### .status.backup.numberOfDBServers: uint
### .status.backup.numberOfDBServers: integer

NumberOfDBServers Cluster size of the Backup in ArangoDB

[Code Reference](/pkg/apis/backup/v1/backup_status.go#L62)

### .status.backup.potentiallyInconsistent: bool
### .status.backup.potentiallyInconsistent: boolean

[Code Reference](/pkg/apis/backup/v1/backup_status.go#L58)

### .status.backup.sizeInBytes: uint64
### .status.backup.sizeInBytes: integer

SizeInBytes Size of the Backup in ArangoDB.

[Code Reference](/pkg/apis/backup/v1/backup_status.go#L60)

### .status.backup.uploaded: bool
### .status.backup.uploaded: boolean

Uploaded Determines if ArangoBackup has been uploaded

Expand Down
18 changes: 9 additions & 9 deletions docs/api/ArangoBackupPolicy.V1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Spec

### .spec.allowConcurrent: bool
### .spec.allowConcurrent: boolean

AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished

Default Value: true

[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L35)

### .spec.maxBackups: int
### .spec.maxBackups: integer

MaxBackups defines how many backups should be kept in history (per deployment). Oldest healthy Backups will be deleted.
If not specified or 0 then no limit is applied
Expand All @@ -35,37 +35,37 @@ Links:

[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L39)

### .spec.template.backoff.iterations: int
### .spec.template.backoff.iterations: integer

Iterations defines number of iterations before reaching MaxDelay. Default to 5

[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L31)

### .spec.template.backoff.max_delay: int
### .spec.template.backoff.max_delay: integer

MaxDelay defines maximum delay in seconds. Default to 600

[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L29)

### .spec.template.backoff.max_iterations: int
### .spec.template.backoff.max_iterations: integer

MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)

[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L33)

### .spec.template.backoff.min_delay: int
### .spec.template.backoff.min_delay: integer

MinDelay defines minimum delay in seconds. Default to 30

[Code Reference](/pkg/apis/backup/v1/backup_spec_backoff.go#L27)

### .spec.template.lifetime: int64
### .spec.template.lifetime: integer

Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".

[Code Reference](/pkg/apis/backup/v1/backup_policy_spec.go#L61)

### .spec.template.options.allowInconsistent: bool
### .spec.template.options.allowInconsistent: boolean

AllowInconsistent flag for Backup creation request.
If this value is set to true, backup is taken even if we are not able to acquire lock.
Expand All @@ -76,7 +76,7 @@ This field is **immutable**: can't be changed after backup creation

[Code Reference](/pkg/apis/backup/v1/backup_spec.go#L66)

### .spec.template.options.timeout: float32
### .spec.template.options.timeout: number

Timeout for Backup creation request in seconds.

Expand Down
Loading