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

chore: fix auto-generated API docs having wrong metadata info #2927

Merged
merged 7 commits into from
Feb 1, 2024
Merged

chore: fix auto-generated API docs having wrong metadata info #2927

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8f3ddbf
chore: fix crd gen wrong metadata info
RealAnna Jan 31, 2024
737f3a3
chore: fix crd gen wrong metadata info
RealAnna Jan 31, 2024
51537b9
chore: fix link for metadata
RealAnna Jan 31, 2024
ff6148e
chore: fix link for metadata
RealAnna Jan 31, 2024
dcd4c30
chore: fix link for metadata
RealAnna Jan 31, 2024
faaaee2
chore: fix link for metadata
RealAnna Jan 31, 2024
075a409
chore: fix link for metadata
RealAnna Feb 1, 2024
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
4 changes: 2 additions & 2 deletions .github/scripts/generate-crd-docs/templates/type_members.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{- define "type_members" -}}
{{- $field := . -}}
{{- if eq $field.Name "metadata" -}}
Refer to Kubernetes API documentation for fields of `metadata`.
{{- if and (eq $field.Name "metadata") (eq $field.Type.String "k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta") -}}
Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects).
RealAnna marked this conversation as resolved.
Show resolved Hide resolved
{{- else -}}
{{ markdownRenderFieldDoc $field.Doc }}
{{- end -}}
Expand Down
32 changes: 16 additions & 16 deletions docs/docs/reference/api-reference/lifecycle/v1alpha1/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnApp` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
RealAnna marked this conversation as resolved.
Show resolved Hide resolved
| `spec` _[KeptnAppSpec](#keptnappspec)_ | || ✓ |
| `status` _[KeptnAppStatus](#keptnappstatus)_ | || ✓ |

Expand All @@ -188,7 +188,7 @@ KeptnAppList contains a list of KeptnApp
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnAppList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnApp](#keptnapp) array_ | || x |


Expand Down Expand Up @@ -239,7 +239,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnAppVersion` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
RealAnna marked this conversation as resolved.
Show resolved Hide resolved
| `spec` _[KeptnAppVersionSpec](#keptnappversionspec)_ | || ✓ |
| `status` _[KeptnAppVersionStatus](#keptnappversionstatus)_ | || ✓ |

Expand All @@ -256,7 +256,7 @@ KeptnAppVersionList contains a list of KeptnAppVersion
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnAppVersionList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnAppVersion](#keptnappversion) array_ | || x |


Expand Down Expand Up @@ -323,7 +323,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnEvaluation` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
| `spec` _[KeptnEvaluationSpec](#keptnevaluationspec)_ | || ✓ |
| `status` _[KeptnEvaluationStatus](#keptnevaluationstatus)_ | || ✓ |

Expand All @@ -341,7 +341,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnEvaluationDefinition` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
RealAnna marked this conversation as resolved.
Show resolved Hide resolved
| `spec` _[KeptnEvaluationDefinitionSpec](#keptnevaluationdefinitionspec)_ | || ✓ |
| `status` _string_ | unused field || ✓ |

Expand All @@ -358,7 +358,7 @@ KeptnEvaluationDefinitionList contains a list of KeptnEvaluationDefinition
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnEvaluationDefinitionList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnEvaluationDefinition](#keptnevaluationdefinition) array_ | || x |


Expand Down Expand Up @@ -389,7 +389,7 @@ KeptnEvaluationList contains a list of KeptnEvaluation
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnEvaluationList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnEvaluation](#keptnevaluation) array_ | || x |


Expand Down Expand Up @@ -448,7 +448,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnTask` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
| `spec` _[KeptnTaskSpec](#keptntaskspec)_ | || ✓ |
| `status` _[KeptnTaskStatus](#keptntaskstatus)_ | || ✓ |

Expand All @@ -466,7 +466,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnTaskDefinition` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
RealAnna marked this conversation as resolved.
Show resolved Hide resolved
| `spec` _[KeptnTaskDefinitionSpec](#keptntaskdefinitionspec)_ | || ✓ |
| `status` _[KeptnTaskDefinitionStatus](#keptntaskdefinitionstatus)_ | || ✓ |

Expand All @@ -483,7 +483,7 @@ KeptnTaskDefinitionList contains a list of KeptnTaskDefinition
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnTaskDefinitionList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnTaskDefinition](#keptntaskdefinition) array_ | || x |


Expand Down Expand Up @@ -527,7 +527,7 @@ KeptnTaskList contains a list of KeptnTask
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnTaskList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnTask](#keptntask) array_ | || x |


Expand Down Expand Up @@ -584,7 +584,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnWorkload` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
RealAnna marked this conversation as resolved.
Show resolved Hide resolved
| `spec` _[KeptnWorkloadSpec](#keptnworkloadspec)_ | || ✓ |
| `status` _[KeptnWorkloadStatus](#keptnworkloadstatus)_ | || ✓ |

Expand All @@ -602,7 +602,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnWorkloadInstance` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation on [`metadata`](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#attaching-metadata-to-objects). || ✓ |
| `spec` _[KeptnWorkloadInstanceSpec](#keptnworkloadinstancespec)_ | || ✓ |
| `status` _[KeptnWorkloadInstanceStatus](#keptnworkloadinstancestatus)_ | || ✓ |

Expand All @@ -619,7 +619,7 @@ KeptnWorkloadInstanceList contains a list of KeptnWorkloadInstance
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnWorkloadInstanceList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnWorkloadInstance](#keptnworkloadinstance) array_ | || x |


Expand Down Expand Up @@ -685,7 +685,7 @@ KeptnWorkloadList contains a list of KeptnWorkload
| --- | --- | --- | --- |
| `apiVersion` _string_ | `lifecycle.keptn.sh/v1alpha1` | | |
| `kind` _string_ | `KeptnWorkloadList` | | |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. || ✓ |
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#listmeta-v1-meta)_ | || ✓ |
| `items` _[KeptnWorkload](#keptnworkload) array_ | || x |


Expand Down
Loading
Loading