Skip to content

Commit 502c84c

Browse files
committed
Regenerate API docs and update example timestamps
Fixes the CI "Run code generation checks" failure by regenerating the API reference documentation to match the updated ExpiresAt field comment from commit 2f8f841. Changes: - Run 'make docs' to regenerate docs/api-reference/api.md - Updates ExpiresAt description from "If not set along with TTL" to "If neither ExpiresAt nor TTL is set" for clarity - Update example timestamps in docs/usage/bmcuser-ttl.md - Change from past dates (2026-04-10/11) to future dates (2026-05-18/19) - Maintains 30-minute warning period context in examples All functional bugs were already fixed in commit 2f8f841 - this is purely documentation cleanup to unblock CI. Signed-off-by: Stefan Hipfel <stefan.hipfel@sap.com>
1 parent 12b98e8 commit 502c84c

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/api-reference/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,7 @@ _Appears in:_
715715
| `bmcSecretRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core)_ | BMCSecretRef references the BMCSecret containing the credentials for this user.<br />If not set, the operator will generate a secure password based on BMC manufacturer requirements. | | |
716716
| `bmcRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core)_ | BMCRef references the BMC this user should be created on. | | |
717717
| `ttl` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#duration-v1-meta)_ | TTL specifies the time-to-live duration for this user.<br />When set, the user will be automatically deleted after this duration from creation.<br />This is useful for temporary debugging users.<br />If not set, the user is permanent (no automatic deletion).<br />Mutually exclusive with ExpiresAt - only one should be set. | | Pattern: `^([0-9]+(\.[0-9]+)?(ns\|us\|µs\|ms\|s\|m\|h))+$` <br />Type: string <br /> |
718-
| `expiresAt` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta)_ | ExpiresAt specifies an absolute timestamp when this user should be deleted.<br />This is useful for users that need to expire at a specific time.<br />If not set along with TTL, the user is permanent.<br />Mutually exclusive with TTL - only one should be set. | | |
718+
| `expiresAt` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta)_ | ExpiresAt specifies an absolute timestamp when this user should be deleted.<br />This is useful for users that need to expire at a specific time.<br />If neither ExpiresAt nor TTL is set, the user is permanent (no automatic deletion).<br />Mutually exclusive with TTL - only one should be set. | | |
719719

720720

721721
#### BMCUserStatus

docs/usage/bmcuser-ttl.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ $ kubectl get bmcuser -o wide
138138

139139
NAME ID USERNAME ROLEID EXPIRESAT LASTROTATION AGE
140140
bmcuser-permanent 5 admin Administrator <none> 2h ago 3d
141-
bmcuser-debug-temporary 6 debug-admin Administrator 2026-04-10T23:00:00Z 1h ago 7h
142-
bmcuser-maintenance-window 7 maintenance-user Operator 2026-04-11T02:00:00Z <none> 4h
141+
bmcuser-debug-temporary 6 debug-admin Administrator 2026-05-18T23:00:00Z 1h ago 7h
142+
bmcuser-maintenance-window 7 maintenance-user Operator 2026-05-19T02:00:00Z <none> 4h
143143
```
144144

145145
### Check User Status
@@ -150,12 +150,12 @@ $ kubectl describe bmcuser bmcuser-debug-temporary
150150
...
151151
Status:
152152
Conditions:
153-
Last Transition Time: 2026-04-10T22:30:00Z
154-
Message: User will expire in 30m at 2026-04-10T23:00:00Z
153+
Last Transition Time: 2026-05-18T22:30:00Z
154+
Message: User will expire in 30m at 2026-05-18T23:00:00Z
155155
Reason: ExpiringSoon
156156
Status: True
157157
Type: Active
158-
Expires At: 2026-04-10T23:00:00Z
158+
Expires At: 2026-05-18T23:00:00Z
159159
ID: 6
160160
...
161161
```

0 commit comments

Comments
 (0)