mirror of
https://github.com/kyverno/kyverno.git
synced 2025-03-28 18:38:40 +00:00
fix: api reference docs (#4490)
Signed-off-by: Charles-Edouard Brétéché <charled.breteche@gmail.com> Signed-off-by: Charles-Edouard Brétéché <charled.breteche@gmail.com>
This commit is contained in:
Charles-Edouard Brétéché
GitHub
parent
a95d61b9d7
commit
92e223b7ff
6 changed files with 244 additions and 245 deletions
1
.github/workflows/e2e-autogen-internals.yaml
vendored
1
.github/workflows/e2e-autogen-internals.yaml
vendored
|
|
@ -14,7 +14,6 @@ on:
|
|||
- 'release*'
|
||||
paths-ignore:
|
||||
- 'README.md'
|
||||
- 'docs/**'
|
||||
- '.github/config.yml'
|
||||
|
||||
permissions: read-all
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -48,7 +48,7 @@ Resource Types:
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>apiVersion</code></br>
|
||||
<code>apiVersion</code><br/>
|
||||
string</td>
|
||||
<td>
|
||||
<code>
|
||||
|
|
@ -58,14 +58,14 @@ kyverno.io/v1alpha2
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>kind</code></br>
|
||||
<code>kind</code><br/>
|
||||
string
|
||||
</td>
|
||||
<td><code>ClusterReportChangeRequest</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>metadata</code></br>
|
||||
<code>metadata</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta">
|
||||
Kubernetes meta/v1.ObjectMeta
|
||||
|
|
@ -79,7 +79,7 @@ Refer to the Kubernetes API documentation for the fields of the
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>scope</code></br>
|
||||
<code>scope</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectreference-v1-core">
|
||||
Kubernetes core/v1.ObjectReference
|
||||
|
|
@ -93,7 +93,7 @@ Kubernetes core/v1.ObjectReference
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>scopeSelector</code></br>
|
||||
<code>scopeSelector</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta">
|
||||
Kubernetes meta/v1.LabelSelector
|
||||
|
|
@ -108,7 +108,7 @@ Either one of, or none of, but not both of, Scope or ScopeSelector should be spe
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>summary</code></br>
|
||||
<code>summary</code><br/>
|
||||
<em>
|
||||
github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary
|
||||
</em>
|
||||
|
|
@ -120,7 +120,7 @@ github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>results</code></br>
|
||||
<code>results</code><br/>
|
||||
<em>
|
||||
[]github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportResult
|
||||
</em>
|
||||
|
|
@ -148,7 +148,7 @@ github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>apiVersion</code></br>
|
||||
<code>apiVersion</code><br/>
|
||||
string</td>
|
||||
<td>
|
||||
<code>
|
||||
|
|
@ -158,14 +158,14 @@ kyverno.io/v1alpha2
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>kind</code></br>
|
||||
<code>kind</code><br/>
|
||||
string
|
||||
</td>
|
||||
<td><code>ReportChangeRequest</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>metadata</code></br>
|
||||
<code>metadata</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta">
|
||||
Kubernetes meta/v1.ObjectMeta
|
||||
|
|
@ -179,7 +179,7 @@ Refer to the Kubernetes API documentation for the fields of the
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>scope</code></br>
|
||||
<code>scope</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectreference-v1-core">
|
||||
Kubernetes core/v1.ObjectReference
|
||||
|
|
@ -193,7 +193,7 @@ Kubernetes core/v1.ObjectReference
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>scopeSelector</code></br>
|
||||
<code>scopeSelector</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#labelselector-v1-meta">
|
||||
Kubernetes meta/v1.LabelSelector
|
||||
|
|
@ -208,7 +208,7 @@ Either one of, or none of, but not both of, Scope or ScopeSelector should be spe
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>summary</code></br>
|
||||
<code>summary</code><br/>
|
||||
<em>
|
||||
github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary
|
||||
</em>
|
||||
|
|
@ -220,7 +220,7 @@ github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>results</code></br>
|
||||
<code>results</code><br/>
|
||||
<em>
|
||||
[]github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportResult
|
||||
</em>
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ Resource Types:
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>apiVersion</code></br>
|
||||
<code>apiVersion</code><br/>
|
||||
string</td>
|
||||
<td>
|
||||
<code>
|
||||
|
|
@ -56,14 +56,14 @@ kyverno.io/v1beta1
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>kind</code></br>
|
||||
<code>kind</code><br/>
|
||||
string
|
||||
</td>
|
||||
<td><code>UpdateRequest</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>metadata</code></br>
|
||||
<code>metadata</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta">
|
||||
Kubernetes meta/v1.ObjectMeta
|
||||
|
|
@ -77,7 +77,7 @@ Refer to the Kubernetes API documentation for the fields of the
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>spec</code></br>
|
||||
<code>spec</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.UpdateRequestSpec">
|
||||
UpdateRequestSpec
|
||||
|
|
@ -91,7 +91,7 @@ UpdateRequestSpec
|
|||
<table class="table table-striped">
|
||||
<tr>
|
||||
<td>
|
||||
<code>requestType</code></br>
|
||||
<code>requestType</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.RequestType">
|
||||
RequestType
|
||||
|
|
@ -104,7 +104,7 @@ RequestType
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>policy</code></br>
|
||||
<code>policy</code><br/>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
|
|
@ -115,7 +115,7 @@ string
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>resource</code></br>
|
||||
<code>resource</code><br/>
|
||||
<em>
|
||||
github.com/kyverno/kyverno/api/kyverno/v1.ResourceSpec
|
||||
</em>
|
||||
|
|
@ -126,7 +126,7 @@ github.com/kyverno/kyverno/api/kyverno/v1.ResourceSpec
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>context</code></br>
|
||||
<code>context</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.UpdateRequestSpecContext">
|
||||
UpdateRequestSpecContext
|
||||
|
|
@ -142,7 +142,7 @@ UpdateRequestSpecContext
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>status</code></br>
|
||||
<code>status</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.UpdateRequestStatus">
|
||||
UpdateRequestStatus
|
||||
|
|
@ -176,7 +176,7 @@ UpdateRequestStatus
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>admissionRequest</code></br>
|
||||
<code>admissionRequest</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#admissionrequest-v1-admission">
|
||||
Kubernetes admission/v1.AdmissionRequest
|
||||
|
|
@ -189,7 +189,7 @@ Kubernetes admission/v1.AdmissionRequest
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>operation</code></br>
|
||||
<code>operation</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#operation-v1-admission">
|
||||
Kubernetes admission/v1.Operation
|
||||
|
|
@ -222,7 +222,7 @@ Kubernetes admission/v1.Operation
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>roles</code></br>
|
||||
<code>roles</code><br/>
|
||||
<em>
|
||||
[]string
|
||||
</em>
|
||||
|
|
@ -234,7 +234,7 @@ Kubernetes admission/v1.Operation
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>clusterRoles</code></br>
|
||||
<code>clusterRoles</code><br/>
|
||||
<em>
|
||||
[]string
|
||||
</em>
|
||||
|
|
@ -246,7 +246,7 @@ Kubernetes admission/v1.Operation
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>userInfo</code></br>
|
||||
<code>userInfo</code><br/>
|
||||
<em>
|
||||
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#userinfo-v1-authentication">
|
||||
Kubernetes authentication/v1.UserInfo
|
||||
|
|
@ -288,7 +288,7 @@ Kubernetes authentication/v1.UserInfo
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>requestType</code></br>
|
||||
<code>requestType</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.RequestType">
|
||||
RequestType
|
||||
|
|
@ -301,7 +301,7 @@ RequestType
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>policy</code></br>
|
||||
<code>policy</code><br/>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
|
|
@ -312,7 +312,7 @@ string
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>resource</code></br>
|
||||
<code>resource</code><br/>
|
||||
<em>
|
||||
github.com/kyverno/kyverno/api/kyverno/v1.ResourceSpec
|
||||
</em>
|
||||
|
|
@ -323,7 +323,7 @@ github.com/kyverno/kyverno/api/kyverno/v1.ResourceSpec
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>context</code></br>
|
||||
<code>context</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.UpdateRequestSpecContext">
|
||||
UpdateRequestSpecContext
|
||||
|
|
@ -356,7 +356,7 @@ UpdateRequestSpecContext
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>userInfo</code></br>
|
||||
<code>userInfo</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.RequestInfo">
|
||||
RequestInfo
|
||||
|
|
@ -369,7 +369,7 @@ RequestInfo
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>admissionRequestInfo</code></br>
|
||||
<code>admissionRequestInfo</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.AdmissionRequestInfoObject">
|
||||
AdmissionRequestInfoObject
|
||||
|
|
@ -411,7 +411,7 @@ AdmissionRequestInfoObject
|
|||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>handler</code></br>
|
||||
<code>handler</code><br/>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
|
|
@ -422,7 +422,7 @@ string
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>state</code></br>
|
||||
<code>state</code><br/>
|
||||
<em>
|
||||
<a href="#kyverno.io/v1beta1.UpdateRequestState">
|
||||
UpdateRequestState
|
||||
|
|
@ -435,7 +435,7 @@ UpdateRequestState
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>message</code></br>
|
||||
<code>message</code><br/>
|
||||
<em>
|
||||
string
|
||||
</em>
|
||||
|
|
@ -447,7 +447,7 @@ string
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>generatedResources</code></br>
|
||||
<code>generatedResources</code><br/>
|
||||
<em>
|
||||
[]github.com/kyverno/kyverno/api/kyverno/v1.ResourceSpec
|
||||
</em>
|
||||
|
|
|
|||
2
docs/template/members.tpl
vendored
2
docs/template/members.tpl
vendored
|
|
@ -4,7 +4,7 @@
|
|||
{{ if not (hiddenMember .)}}
|
||||
<tr>
|
||||
<td>
|
||||
<code>{{ fieldName . }}</code></br>
|
||||
<code>{{ fieldName . }}</code><br/>
|
||||
<em>
|
||||
{{ if linkForType .Type }}
|
||||
<a href="{{ linkForType .Type}}">
|
||||
|
|
|
|||
4
docs/template/type.tpl
vendored
4
docs/template/type.tpl
vendored
|
|
@ -34,7 +34,7 @@
|
|||
{{ if isExportedType . }}
|
||||
<tr>
|
||||
<td>
|
||||
<code>apiVersion</code></br>
|
||||
<code>apiVersion</code><br/>
|
||||
string</td>
|
||||
<td>
|
||||
<code>
|
||||
|
|
@ -44,7 +44,7 @@
|
|||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>kind</code></br>
|
||||
<code>kind</code><br/>
|
||||
string
|
||||
</td>
|
||||
<td><code>{{.Name.Name}}</code></td>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue