Skip to content

Commit

Permalink
fix: missing enumerated values in generated docs for warehouse (#2969)
Browse files Browse the repository at this point in the history
Signed-off-by: Faeka Ansari <[email protected]>
(cherry picked from commit 27f501c)
  • Loading branch information
fykaa authored and github-actions[bot] committed Nov 20, 2024
1 parent 6655061 commit 31aa19d
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 3 deletions.
3 changes: 3 additions & 0 deletions api/v1alpha1/generated.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions api/v1alpha1/warehouse_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ type WarehouseSpec struct {
// FreightCreationPolicy describes how Freight is created by this Warehouse.
// This field is optional. When left unspecified, the field is implicitly
// treated as if its value were "Automatic".
// Accepted values: Automatic, Manual
//
// +kubebuilder:default=Automatic
// +kubebuilder:validation:Optional
Expand Down Expand Up @@ -111,6 +112,7 @@ type GitSubscription struct {
// commit of interest in the repository specified by the RepoURL field. This
// field is optional. When left unspecified, the field is implicitly treated
// as if its value were "NewestFromBranch".
// Accepted values: Lexical, NewestFromBranch, NewestTag, SemVer
//
// +kubebuilder:default=NewestFromBranch
CommitSelectionStrategy CommitSelectionStrategy `json:"commitSelectionStrategy,omitempty" protobuf:"bytes,2,opt,name=commitSelectionStrategy"`
Expand Down Expand Up @@ -224,6 +226,7 @@ type ImageSubscription struct {
// of the image specified by the RepoURL field. This field is optional. When
// left unspecified, the field is implicitly treated as if its value were
// "SemVer".
// Accepted values: Digest, Lexical, NewestBuild, SemVer
//
// +kubebuilder:default=SemVer
ImageSelectionStrategy ImageSelectionStrategy `json:"imageSelectionStrategy,omitempty" protobuf:"bytes,3,opt,name=imageSelectionStrategy"`
Expand Down
3 changes: 3 additions & 0 deletions charts/kargo/resources/crds/kargo.akuity.io_warehouses.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ spec:
FreightCreationPolicy describes how Freight is created by this Warehouse.
This field is optional. When left unspecified, the field is implicitly
treated as if its value were "Automatic".
Accepted values: Automatic, Manual
enum:
- Automatic
- Manual
Expand Down Expand Up @@ -161,6 +162,7 @@ spec:
commit of interest in the repository specified by the RepoURL field. This
field is optional. When left unspecified, the field is implicitly treated
as if its value were "NewestFromBranch".
Accepted values: Lexical, NewestFromBranch, NewestTag, SemVer
enum:
- Lexical
- NewestFromBranch
Expand Down Expand Up @@ -306,6 +308,7 @@ spec:
of the image specified by the RepoURL field. This field is optional. When
left unspecified, the field is implicitly treated as if its value were
"SemVer".
Accepted values: Digest, Lexical, NewestBuild, SemVer
enum:
- Digest
- Lexical
Expand Down
6 changes: 3 additions & 3 deletions ui/src/gen/schema/warehouses.kargo.akuity.io_v1alpha1.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"properties": {
"freightCreationPolicy": {
"default": "Automatic",
"description": "FreightCreationPolicy describes how Freight is created by this Warehouse.\nThis field is optional. When left unspecified, the field is implicitly\ntreated as if its value were \"Automatic\".",
"description": "FreightCreationPolicy describes how Freight is created by this Warehouse.\nThis field is optional. When left unspecified, the field is implicitly\ntreated as if its value were \"Automatic\".\nAccepted values: Automatic, Manual",
"enum": [
"Automatic",
"Manual"
Expand Down Expand Up @@ -86,7 +86,7 @@
},
"commitSelectionStrategy": {
"default": "NewestFromBranch",
"description": "CommitSelectionStrategy specifies the rules for how to identify the newest\ncommit of interest in the repository specified by the RepoURL field. This\nfield is optional. When left unspecified, the field is implicitly treated\nas if its value were \"NewestFromBranch\".",
"description": "CommitSelectionStrategy specifies the rules for how to identify the newest\ncommit of interest in the repository specified by the RepoURL field. This\nfield is optional. When left unspecified, the field is implicitly treated\nas if its value were \"NewestFromBranch\".\nAccepted values: Lexical, NewestFromBranch, NewestTag, SemVer",
"enum": [
"Lexical",
"NewestFromBranch",
Expand Down Expand Up @@ -179,7 +179,7 @@
},
"imageSelectionStrategy": {
"default": "SemVer",
"description": "ImageSelectionStrategy specifies the rules for how to identify the newest version\nof the image specified by the RepoURL field. This field is optional. When\nleft unspecified, the field is implicitly treated as if its value were\n\"SemVer\".",
"description": "ImageSelectionStrategy specifies the rules for how to identify the newest version\nof the image specified by the RepoURL field. This field is optional. When\nleft unspecified, the field is implicitly treated as if its value were\n\"SemVer\".\nAccepted values: Digest, Lexical, NewestBuild, SemVer",
"enum": [
"Digest",
"Lexical",
Expand Down
3 changes: 3 additions & 0 deletions ui/src/gen/v1alpha1/generated_pb.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1558,6 +1558,7 @@ export class GitSubscription extends Message<GitSubscription> {
* commit of interest in the repository specified by the RepoURL field. This
* field is optional. When left unspecified, the field is implicitly treated
* as if its value were "NewestFromBranch".
* Accepted values: Lexical, NewestFromBranch, NewestTag, SemVer
*
* +kubebuilder:default=NewestFromBranch
*
Expand Down Expand Up @@ -2035,6 +2036,7 @@ export class ImageSubscription extends Message<ImageSubscription> {
* of the image specified by the RepoURL field. This field is optional. When
* left unspecified, the field is implicitly treated as if its value were
* "SemVer".
* Accepted values: Digest, Lexical, NewestBuild, SemVer
*
* +kubebuilder:default=SemVer
*
Expand Down Expand Up @@ -3642,6 +3644,7 @@ export class WarehouseSpec extends Message<WarehouseSpec> {
* FreightCreationPolicy describes how Freight is created by this Warehouse.
* This field is optional. When left unspecified, the field is implicitly
* treated as if its value were "Automatic".
* Accepted values: Automatic, Manual
*
* +kubebuilder:default=Automatic
* +kubebuilder:validation:Optional
Expand Down

0 comments on commit 31aa19d

Please sign in to comment.