Skip to content

[release-1.27] Changes on crd-ref-docs templates to add API version to the CRD #1370

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

Merged
istio-testing merged 1 commit into from
Nov 20, 2025
Merged

[release-1.27] Changes on crd-ref-docs templates to add API version to the CRD #1370

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
40 changes: 20 additions & 20 deletions docs/api-reference/sailoperator.io.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
package v1 contains API Schema definitions for the sailoperator.io v1 API group

### Resource Types
- [Istio](#istio)
- [IstioCNI](#istiocni)
- [IstioCNIList](#istiocnilist)
- [IstioList](#istiolist)
- [IstioRevision](#istiorevision)
- [IstioRevisionList](#istiorevisionlist)
- [IstioRevisionTag](#istiorevisiontag)
- [IstioRevisionTagList](#istiorevisiontaglist)
- [Istio](#istio-v1)
- [IstioCNI](#istiocni-v1)
- [IstioCNIList](#istiocnilist-v1)
- [IstioList](#istiolist-v1)
- [IstioRevision](#istiorevision-v1)
- [IstioRevisionList](#istiorevisionlist-v1)
- [IstioRevisionTag](#istiorevisiontag-v1)
- [IstioRevisionTagList](#istiorevisiontaglist-v1)



Expand Down Expand Up @@ -513,7 +513,7 @@ _Appears in:_



#### Istio
#### Istio (v1)



Expand Down Expand Up @@ -541,7 +541,7 @@ _Appears in:_
| `status` _[IstioStatus](#istiostatus)_ | | | |


#### IstioCNI
#### IstioCNI (v1)



Expand Down Expand Up @@ -622,7 +622,7 @@ _Appears in:_
| `Ready` | IstioCNIConditionReady signifies whether the istio-cni-node DaemonSet is ready. |


#### IstioCNIList
#### IstioCNIList (v1)



Expand Down Expand Up @@ -745,7 +745,7 @@ _Appears in:_
| `DependenciesHealthy` | IstioConditionDependenciesHealthy signifies whether the dependencies required by this Istio are healthy. For example, an Istio with spec.values.pilot.cni.enabled=true requires the IstioCNI resource to be deployed and ready for the Istio revision to be considered healthy. The DependenciesHealthy condition is used to indicate that the IstioCNI resource is healthy. |


#### IstioList
#### IstioList (v1)



Expand All @@ -765,7 +765,7 @@ IstioList contains a list of Istio
| `items` _[Istio](#istio) array_ | | | |


#### IstioRevision
#### IstioRevision (v1)



Expand Down Expand Up @@ -858,7 +858,7 @@ _Appears in:_
| `DependenciesHealthy` | IstioRevisionConditionDependenciesHealthy signifies whether the dependencies required by this IstioRevision are healthy. For example, an IstioRevision with spec.values.pilot.cni.enabled=true requires the IstioCNI resource to be deployed and ready for the Istio revision to be considered healthy. The DependenciesHealthy condition is used to indicate that the IstioCNI resource is healthy. |


#### IstioRevisionList
#### IstioRevisionList (v1)



Expand Down Expand Up @@ -914,7 +914,7 @@ _Appears in:_
| `state` _[IstioRevisionConditionReason](#istiorevisionconditionreason)_ | Reports the current state of the object. | | |


#### IstioRevisionTag
#### IstioRevisionTag (v1)



Expand Down Expand Up @@ -998,7 +998,7 @@ _Appears in:_
| `InUse` | IstioRevisionConditionInUse signifies whether any workload is configured to use the revision. |


#### IstioRevisionTagList
#### IstioRevisionTagList (v1)



Expand Down Expand Up @@ -3333,12 +3333,12 @@ _Appears in:_
Package v1alpha1 contains API Schema definitions for the sailoperator.io v1alpha1 API group

### Resource Types
- [ZTunnel](#ztunnel)
- [ZTunnelList](#ztunnellist)
- [ZTunnel](#ztunnel-v1alpha1)
- [ZTunnelList](#ztunnellist-v1alpha1)



#### ZTunnel
#### ZTunnel (v1alpha1)



Expand Down Expand Up @@ -3419,7 +3419,7 @@ _Appears in:_
| `Ready` | ZTunnelConditionReady signifies whether the ztunnel DaemonSet is ready. |


#### ZTunnelList
#### ZTunnelList (v1alpha1)



Expand Down
7 changes: 6 additions & 1 deletion hack/api-docs/templates/markdown/gv_details.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@
{{- if $gv.Kinds }}
### Resource Types
{{- range $gv.SortedKinds }}
- {{ $gv.TypeForKind . | markdownRenderTypeLink }}
{{- $type := $gv.TypeForKind . }}
{{- if $type.GVK }}
- [{{ $type.Name }}](#{{ $type.Name | lower }}-{{ $type.GVK.Version }})
{{- else }}
- [{{ $type.Name }}](#{{ $type.Name | lower }})
{{- end }}
{{- end }}
{{ end }}

Expand Down
4 changes: 4 additions & 0 deletions hack/api-docs/templates/markdown/type.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
{{- if markdownShouldRenderType $type -}}
{{- if not $type.Markers.hidefromdoc -}}

{{- if $type.GVK -}}
#### {{ $type.Name }} ({{ $type.GVK.Version }})
{{- else -}}
#### {{ $type.Name }}
{{- end }}

{{ if $type.IsAlias }}_Underlying type:_ _{{ markdownRenderTypeLink $type.UnderlyingType }}_{{ end }}

Expand Down