Skip to content

Commit c73a144

Browse files
authored
[Documentation] Add Required & Skip in Docs (#1932)
1 parent 44441a5 commit c73a144

37 files changed

+562
-479
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- (Feature) Extend DebugPackage with Debug files
66
- (Documentation) Shutdown Debug Feature
77
- (Documentation) ManualUpgrade Docs
8+
- (Documentation) Add Required & Skip in Docs
89

910
## [1.2.50](https://github.com/arangodb/kube-arangodb/tree/1.2.50) (2025-07-04)
1011
- (Feature) (Platform) MetaV1 Integration Service

docs/api/ArangoDeployment.V1.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,7 +1017,7 @@ Possible Values:
10171017

10181018
### .spec.architecture
10191019

1020-
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L260)</sup>
1020+
Type: `[]string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L259)</sup>
10211021

10221022
Architecture defines the list of supported architectures.
10231023
First element on the list is marked as default architecture.
@@ -1094,18 +1094,17 @@ KillPodProbability is the chance of a pod being killed during an event
10941094

10951095
### .spec.ClusterDomain
10961096

1097-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L232)</sup>
1097+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L231)</sup>
10981098

10991099
ClusterDomain define domain used in the kubernetes cluster.
1100-
Required only of domain is not set to default (cluster.local)
11011100

11021101
Default Value: `cluster.local`
11031102

11041103
***
11051104

11061105
### .spec.communicationMethod
11071106

1108-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L240)</sup>
1107+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L239)</sup>
11091108

11101109
CommunicationMethod define communication method used in deployment
11111110

@@ -3178,31 +3177,33 @@ Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.
31783177

31793178
### .spec.gateway.authentication.secret.checksum
31803179

3181-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L61)</sup>
3180+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L62)</sup>
31823181

31833182
UID keeps the information about object Checksum
31843183

31853184
***
31863185

31873186
### .spec.gateway.authentication.secret.name
31883187

3189-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L52)</sup>
3188+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L53)</sup>
3189+
3190+
This field is **required**
31903191

31913192
Name of the object
31923193

31933194
***
31943195

31953196
### .spec.gateway.authentication.secret.namespace
31963197

3197-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L55)</sup>
3198+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L56)</sup>
31983199

31993200
Namespace of the object. Should default to the namespace of the parent object
32003201

32013202
***
32023203

32033204
### .spec.gateway.authentication.secret.uid
32043205

3205-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L58)</sup>
3206+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L59)</sup>
32063207

32073208
UID keeps the information about object UID
32083209

@@ -8198,7 +8199,7 @@ MaintenanceGracePeriod action timeout
81988199

81998200
### .spec.timezone
82008201

8201-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L264)</sup>
8202+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/deployment/v1/deployment_spec.go#L263)</sup>
82028203

82038204
Timezone if specified, will set a timezone for deployment.
82048205
Must be in format accepted by "tzdata", e.g. `America/New_York` or `Europe/London`

docs/api/ArangoMLBatchJob.V1Alpha1.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,31 +36,33 @@ MLConditions specific to the entire batch job
3636

3737
### .status.ref.checksum
3838

39-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L61)</sup>
39+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L62)</sup>
4040

4141
UID keeps the information about object Checksum
4242

4343
***
4444

4545
### .status.ref.name
4646

47-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L52)</sup>
47+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L53)</sup>
48+
49+
This field is **required**
4850

4951
Name of the object
5052

5153
***
5254

5355
### .status.ref.namespace
5456

55-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L55)</sup>
57+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L56)</sup>
5658

5759
Namespace of the object. Should default to the namespace of the parent object
5860

5961
***
6062

6163
### .status.ref.uid
6264

63-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L58)</sup>
65+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L59)</sup>
6466

6567
UID keeps the information about object UID
6668

docs/api/ArangoMLCronJob.V1Alpha1.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,31 +36,33 @@ MLConditions specific to the entire cron job
3636

3737
### .status.ref.checksum
3838

39-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L61)</sup>
39+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L62)</sup>
4040

4141
UID keeps the information about object Checksum
4242

4343
***
4444

4545
### .status.ref.name
4646

47-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L52)</sup>
47+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L53)</sup>
48+
49+
This field is **required**
4850

4951
Name of the object
5052

5153
***
5254

5355
### .status.ref.namespace
5456

55-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L55)</sup>
57+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L56)</sup>
5658

5759
Namespace of the object. Should default to the namespace of the parent object
5860

5961
***
6062

6163
### .status.ref.uid
6264

63-
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L58)</sup>
65+
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.50/pkg/apis/shared/v1/object.go#L59)</sup>
6466

6567
UID keeps the information about object UID
6668

0 commit comments

Comments
 (0)