Skip to content

Commit 366ba7f

Browse files
feloyfsmunoz
authored andcommitted
API Reference multi-pages for v1.26
1 parent 28dc4ae commit 366ba7f

36 files changed

+18214
-9990
lines changed

api-ref-assets/api/swagger.json

Lines changed: 14081 additions & 8509 deletions
Large diffs are not rendered by default.

api-ref-assets/config/fields.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@
5454
- name: Alpha level
5555
fields:
5656
- hostUsers
57+
- resourceClaims
58+
- schedulingGates
5759
- name: Deprecated
5860
fields:
5961
- serviceAccount
@@ -317,6 +319,7 @@
317319
- volumeClaimTemplates
318320
- minReadySeconds
319321
- persistentVolumeClaimRetentionPolicy
322+
- ordinals
320323

321324
- definition: io.k8s.api.apps.v1.StatefulSetUpdateStrategy
322325
field_categories:
@@ -593,7 +596,7 @@
593596
- volumeName
594597
- storageClassName
595598
- volumeMode
596-
- name: Beta level
599+
- name: Alpha level
597600
fields:
598601
- dataSource
599602
- dataSourceRef

api-ref-assets/config/toc.yaml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,21 @@ parts:
6363
- name: HorizontalPodAutoscaler
6464
group: autoscaling
6565
version: v2
66-
- name: HorizontalPodAutoscaler
67-
group: autoscaling
68-
version: v2beta2
6966
- name: PriorityClass
7067
group: scheduling.k8s.io
7168
version: v1
69+
- name: PodScheduling
70+
group: resource.k8s.io
71+
version: v1alpha1
72+
- name: ResourceClaim
73+
group: resource.k8s.io
74+
version: v1alpha1
75+
- name: ResourceClaimTemplate
76+
group: resource.k8s.io
77+
version: v1alpha1
78+
- name: ResourceClass
79+
group: resource.k8s.io
80+
version: v1alpha1
7281
- name: Service Resources
7382
chapters:
7483
- name: Service
@@ -153,6 +162,9 @@ parts:
153162
- name: SubjectAccessReview
154163
group: authorization.k8s.io
155164
version: v1
165+
- name: SelfSubjectReview
166+
group: authentication.k8s.io
167+
version: v1alpha1
156168
- name: ClusterRole
157169
group: rbac.authorization.k8s.io
158170
version: v1
@@ -195,6 +207,12 @@ parts:
195207
- name: ValidatingWebhookConfiguration
196208
group: admissionregistration.k8s.io
197209
version: v1
210+
- name: ValidatingAdmissionPolicy
211+
group: admissionregistration.k8s.io
212+
version: v1alpha1
213+
otherDefinitions:
214+
- ValidatingAdmissionPolicyList
215+
- ValidatingAdmissionPolicyBinding
198216
- name: Cluster Resources
199217
chapters:
200218
- name: Node
@@ -217,10 +235,10 @@ parts:
217235
version: v1
218236
- name: FlowSchema
219237
group: flowcontrol.apiserver.k8s.io
220-
version: v1beta2
238+
version: v1beta3
221239
- name: PriorityLevelConfiguration
222240
group: flowcontrol.apiserver.k8s.io
223-
version: v1beta2
241+
version: v1beta3
224242
- name: Binding
225243
group: ""
226244
version: v1

content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-binding-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ api_metadata:
66
content_type: "api_reference"
77
description: "ClusterRoleBinding references a ClusterRole, but not contain it."
88
title: "ClusterRoleBinding"
9-
weight: 6
9+
weight: 7
1010
auto_generated: true
1111
---
1212

content/en/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ api_metadata:
66
content_type: "api_reference"
77
description: "ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding."
88
title: "ClusterRole"
9-
weight: 5
9+
weight: 6
1010
auto_generated: true
1111
---
1212

content/en/docs/reference/kubernetes-api/authorization-resources/role-binding-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ api_metadata:
66
content_type: "api_reference"
77
description: "RoleBinding references a role, but does not contain it."
88
title: "RoleBinding"
9-
weight: 8
9+
weight: 9
1010
auto_generated: true
1111
---
1212

content/en/docs/reference/kubernetes-api/authorization-resources/role-v1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ api_metadata:
66
content_type: "api_reference"
77
description: "Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding."
88
title: "Role"
9-
weight: 7
9+
weight: 8
1010
auto_generated: true
1111
---
1212

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
---
2+
api_metadata:
3+
apiVersion: "authentication.k8s.io/v1alpha1"
4+
import: "k8s.io/api/authentication/v1alpha1"
5+
kind: "SelfSubjectReview"
6+
content_type: "api_reference"
7+
description: "SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request."
8+
title: "SelfSubjectReview v1alpha1"
9+
weight: 5
10+
auto_generated: true
11+
---
12+
13+
<!--
14+
The file is auto-generated from the Go source code of the component using a generic
15+
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
16+
to generate the reference documentation, please read
17+
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
18+
To update the reference content, please follow the
19+
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
20+
guide. You can file document formatting bugs against the
21+
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
22+
-->
23+
24+
`apiVersion: authentication.k8s.io/v1alpha1`
25+
26+
`import "k8s.io/api/authentication/v1alpha1"`
27+
28+
29+
## SelfSubjectReview {#SelfSubjectReview}
30+
31+
SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated.
32+
33+
<hr>
34+
35+
- **apiVersion**: authentication.k8s.io/v1alpha1
36+
37+
38+
- **kind**: SelfSubjectReview
39+
40+
41+
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
42+
43+
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
44+
45+
- **status** (<a href="{{< ref "../authorization-resources/self-subject-review-v1alpha1#SelfSubjectReviewStatus" >}}">SelfSubjectReviewStatus</a>)
46+
47+
Status is filled in by the server with the user attributes.
48+
49+
50+
51+
52+
53+
## SelfSubjectReviewStatus {#SelfSubjectReviewStatus}
54+
55+
SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user.
56+
57+
<hr>
58+
59+
- **userInfo** (UserInfo)
60+
61+
User attributes of the user making this request.
62+
63+
<a name="UserInfo"></a>
64+
*UserInfo holds the information about the user needed to implement the user.Info interface.*
65+
66+
- **userInfo.extra** (map[string][]string)
67+
68+
Any additional information provided by the authenticator.
69+
70+
- **userInfo.groups** ([]string)
71+
72+
The names of groups this user is a part of.
73+
74+
- **userInfo.uid** (string)
75+
76+
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
77+
78+
- **userInfo.username** (string)
79+
80+
The name that uniquely identifies this user among all active users.
81+
82+
83+
84+
85+
86+
## Operations {#Operations}
87+
88+
89+
90+
<hr>
91+
92+
93+
94+
95+
96+
97+
### `create` create a SelfSubjectReview
98+
99+
#### HTTP Request
100+
101+
POST /apis/authentication.k8s.io/v1alpha1/selfsubjectreviews
102+
103+
#### Parameters
104+
105+
106+
- **body**: <a href="{{< ref "../authorization-resources/self-subject-review-v1alpha1#SelfSubjectReview" >}}">SelfSubjectReview</a>, required
107+
108+
109+
110+
111+
- **dryRun** (*in query*): string
112+
113+
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
114+
115+
116+
- **fieldManager** (*in query*): string
117+
118+
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
119+
120+
121+
- **fieldValidation** (*in query*): string
122+
123+
<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation</a>
124+
125+
126+
- **pretty** (*in query*): string
127+
128+
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
129+
130+
131+
132+
#### Response
133+
134+
135+
200 (<a href="{{< ref "../authorization-resources/self-subject-review-v1alpha1#SelfSubjectReview" >}}">SelfSubjectReview</a>): OK
136+
137+
201 (<a href="{{< ref "../authorization-resources/self-subject-review-v1alpha1#SelfSubjectReview" >}}">SelfSubjectReview</a>): Created
138+
139+
202 (<a href="{{< ref "../authorization-resources/self-subject-review-v1alpha1#SelfSubjectReview" >}}">SelfSubjectReview</a>): Accepted
140+
141+
401: Unauthorized
142+

content/en/docs/reference/kubernetes-api/cluster-resources/cluster-cidr-v1alpha1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ ClusterCIDRSpec defines the desired state of ClusterCIDR.
6666

6767
- **ipv6** (string)
6868

69-
IPv6 defines an IPv6 IP block in CIDR notation(e.g. "fd12:3456:789a:1::/64"). At least one of IPv4 and IPv6 must be specified. This field is immutable.
69+
IPv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64"). At least one of IPv4 and IPv6 must be specified. This field is immutable.
7070

7171
- **nodeSelector** (NodeSelector)
7272

0 commit comments

Comments
 (0)