Skip to content

Commit 52062ef

Browse files
authored
Merge pull request kubernetes-sigs#383 from tengqm/api-ref-132
Update the API reference generator for v1.32
2 parents af2e3cf + 2c424d7 commit 52062ef

File tree

4 files changed

+84743
-4
lines changed

4 files changed

+84743
-4
lines changed

gen-apidocs/config/v1_32/config.yaml

Lines changed: 388 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,388 @@
1+
example_location: "examples"
2+
api_groups:
3+
- "AdmissionRegistration"
4+
- "ApiExtensions"
5+
- "InternalApiserver"
6+
- "ApiRegistration"
7+
- "Apps"
8+
- "AuditRegistration"
9+
- "Authentication"
10+
- "Authorization"
11+
- "Autoscaling"
12+
- "Batch"
13+
- "Certificates"
14+
- "Coordination"
15+
- "Core"
16+
- "Discovery"
17+
- "Extensions"
18+
- "FlowControl"
19+
- "Meta"
20+
- "Networking"
21+
- "Node"
22+
- "Policy"
23+
- "Rbac"
24+
- "Resource"
25+
- "Scheduling"
26+
- "Settings"
27+
- "Storage"
28+
- "StorageMigration"
29+
resource_categories:
30+
- name: "Workloads APIs"
31+
include: "workloads"
32+
resources:
33+
- name: Container
34+
version: v1
35+
group: core
36+
description_warning: "Containers are only ever created within the context of a <a href=\"#pod-v1-core\">Pod</a>. This is usually done using a Controller. See Controllers: <a href=\"#deployment-v1-apps\">Deployment</a>, <a href=\"#job-v1-batch\">Job</a>, or <a href=\"#statefulset-v1-apps\">StatefulSet</a>"
37+
- name: CronJob
38+
version: v1
39+
group: batch
40+
- name: DaemonSet
41+
version: v1
42+
group: apps
43+
- name: Deployment
44+
version: v1
45+
group: apps
46+
- name: Job
47+
version: v1
48+
group: batch
49+
- name: Pod
50+
version: v1
51+
group: core
52+
description_warning: "It is recommended that users create Pods only through a Controller, and not directly. See Controllers: <a href=\"#deployment-v1-apps\">Deployment</a>, <a href=\"#job-v1-batch\">Job</a>, or <a href=\"#statefulset-v1-apps\">StatefulSet</a>."
53+
- name: ReplicaSet
54+
version: v1
55+
group: apps
56+
description_warning: "In many cases it is recommended to create a <a href=\"#deployment-v1-apps\">Deployment</a> instead of ReplicaSet."
57+
- name: ReplicationController
58+
version: v1
59+
group: core
60+
description_warning: "In many cases it is recommended to create a <a href=\"#deployment-v1-apps\">Deployment</a> instead of a ReplicationController."
61+
- name: StatefulSet
62+
version: v1
63+
group: apps
64+
- name: "Service APIs"
65+
include: "servicediscovery"
66+
resources:
67+
- name: Endpoints
68+
version: v1
69+
group: core
70+
- name: EndpointSlice
71+
version: v1
72+
group: discovery
73+
- name: Ingress
74+
version: v1
75+
group: networking
76+
- name: IngressClass
77+
version: v1
78+
group: networking
79+
- name: Service
80+
version: v1
81+
group: core
82+
- name: "Config and Storage APIs"
83+
include: "config"
84+
resources:
85+
- name: ConfigMap
86+
version: v1
87+
group: core
88+
- name: CSIDriver
89+
version: v1
90+
group: storage
91+
- name: CSINode
92+
version: v1
93+
group: storage
94+
- name: CSIStorageCapacity
95+
version: v1
96+
group: storage
97+
- name: Secret
98+
version: v1
99+
group: core
100+
- name: PersistentVolumeClaim
101+
version: v1
102+
group: core
103+
description_note: "A <a href=\"#persistentvolume-v1-core\">PersistentVolume</a> must be allocated in the cluster to use this."
104+
- name: StorageClass
105+
version: v1
106+
group: storage
107+
- name: StorageVersionMigration
108+
version: v1alpha1
109+
group: storagemigration
110+
- name: Volume
111+
version: v1
112+
group: core
113+
- name: VolumeAttachment
114+
version: v1
115+
group: storage
116+
- name: VolumeAttributesClass
117+
version: v1beta1
118+
group: storage
119+
- name: "Metadata APIs"
120+
include: "meta"
121+
resources:
122+
- name: ClusterTrustBundle
123+
version: v1alpha1
124+
group: certificates
125+
- name: ControllerRevision
126+
version: v1
127+
group: apps
128+
- name: CustomResourceDefinition
129+
version: v1
130+
group: apiextensions
131+
- name: DeviceClass
132+
version: v1beta1
133+
group: resource
134+
- name: Event
135+
version: v1
136+
group: events
137+
- name: LimitRange
138+
version: v1
139+
group: core
140+
- name: HorizontalPodAutoscaler
141+
version: v2
142+
group: autoscaling
143+
- name: MutatingWebhookConfiguration
144+
version: v1
145+
group: admissionregistration
146+
- name: PodTemplate
147+
version: v1
148+
group: core
149+
- name: PodDisruptionBudget
150+
version: v1
151+
group: policy
152+
- name: PriorityClass
153+
version: v1
154+
group: scheduling
155+
- name: ResourceClaim
156+
version: v1alpha3
157+
group: resource
158+
- name: ResourceClaimTemplate
159+
version: v1beta1
160+
group: resource
161+
- name: ResourceSlice
162+
version: v1beta1
163+
group: resource
164+
- name: ValidatingAdmissionPolicy
165+
version: v1
166+
group: admissionregistration
167+
- name: ValidatingAdmissionPolicyBinding
168+
version: v1
169+
group: admissionregistration
170+
- name: ValidatingWebhookConfiguration
171+
version: v1
172+
group: admissionregistration
173+
- name: "Cluster APIs"
174+
include: "cluster"
175+
resources:
176+
- name: APIService
177+
version: v1
178+
group: apiregistration
179+
- name: Binding
180+
version: v1
181+
group: core
182+
- name: CertificateSigningRequest
183+
version: v1
184+
group: certificates
185+
- name: ClusterRole
186+
version: v1
187+
group: rbac
188+
- name: ClusterRoleBinding
189+
version: v1
190+
group: rbac
191+
- name: ComponentStatus
192+
version: v1
193+
group: core
194+
- name: FlowSchema
195+
version: v1
196+
group: flowcontrol
197+
- name: IPAddress
198+
version: v1beta1
199+
group: networking
200+
- name: Lease
201+
version: v1
202+
group: coordination
203+
- name: LeaseCandidate
204+
version: v1alpha2
205+
group: coordination
206+
- name: LocalSubjectAccessReview
207+
version: v1
208+
group: authorization
209+
- name: Namespace
210+
version: v1
211+
group: core
212+
- name: Node
213+
version: v1
214+
group: core
215+
- name: PersistentVolume
216+
version: v1
217+
group: core
218+
description_note: "These are assigned to <a href=\"#pod-v1-core\">Pods</a> using <a href=\"#persistentvolumeclaim-v1-core\">PersistentVolumeClaims</a>."
219+
- name: PriorityLevelConfiguration
220+
version: v1
221+
group: flowcontrol
222+
- name: ResourceQuota
223+
version: v1
224+
group: core
225+
- name: Role
226+
version: v1
227+
group: rbac
228+
- name: RoleBinding
229+
version: v1
230+
group: rbac
231+
- name: RuntimeClass
232+
version: v1
233+
group: node
234+
- name: SelfSubjectAccessReview
235+
version: v1
236+
group: authorization
237+
- name: SelfSubjectReview
238+
version: v1
239+
group: authentication
240+
- name: SelfSubjectRulesReview
241+
version: v1
242+
group: authorization
243+
- name: ServiceAccount
244+
version: v1
245+
group: core
246+
- name: ServiceCIDR
247+
version: v1beta1
248+
group: networking
249+
- name: StorageVersion
250+
version: v1alpha1
251+
group: apiserverinternal
252+
- name: StorageVersionMigration
253+
version: v1alpha1
254+
group: storagemigration
255+
- name: SubjectAccessReview
256+
version: v1
257+
group: authorization
258+
- name: TokenRequest
259+
version: v1
260+
group: authentication
261+
- name: TokenReview
262+
version: v1
263+
group: authentication
264+
- name: NetworkPolicy
265+
version: v1
266+
group: networking
267+
- name: MutatingAdmissionPolicy
268+
version: v1alpha1
269+
group: admissionregistration
270+
- name: MutatingAdmissionPolicyBinding
271+
version: v1alpha1
272+
group: admissionregistration
273+
274+
operation_categories:
275+
- name: "Proxy Operations"
276+
operation_types:
277+
- name: Create Connect Portforward
278+
match: connect${group}${version}Post(Namespaced)?${resource}Portforward
279+
- name: Create Connect Proxy
280+
match: connect${group}${version}Post(Namespaced)?${resource}Proxy
281+
- name: Create Connect Proxy Path
282+
match: connect${group}${version}Post(Namespaced)?${resource}ProxyWithPath
283+
- name: Create Proxy
284+
match: proxy${group}${version}POST(Namespaced)?${resource}
285+
- name: Create Proxy Path
286+
match: proxy${group}${version}POST(Namespaced)?${resource}WithPath
287+
- name: Delete Connect Proxy
288+
match: connect${group}${version}Delete(Namespaced)?${resource}Proxy
289+
- name: Delete Connect Proxy Path
290+
match: connect${group}${version}Delete(Namespaced)?${resource}ProxyWithPath
291+
- name: Delete Proxy
292+
match: proxy${group}${version}DELETE(Namespaced)?${resource}
293+
- name: Delete Proxy Path
294+
match: proxy${group}${version}DELETE(Namespaced)?${resource}WithPath
295+
- name: Get Connect Portforward
296+
match: connect${group}${version}Get(Namespaced)?${resource}Portforward
297+
- name: Get Connect Proxy
298+
match: connect${group}${version}Get(Namespaced)?${resource}Proxy
299+
- name: Get Connect Proxy Path
300+
match: connect${group}${version}Get(Namespaced)?${resource}ProxyWithPath
301+
- name: Get Proxy
302+
match: proxy${group}${version}GET(Namespaced)?${resource}
303+
- name: Get Proxy Path
304+
match: proxy${group}${version}GET(Namespaced)?${resource}WithPath
305+
- name: Head Connect Proxy
306+
match: connect${group}${version}Head(Namespaced)?${resource}Proxy
307+
- name: Head Connect Proxy Path
308+
match: connect${group}${version}Head(Namespaced)?${resource}ProxyWithPath
309+
- name: Replace Connect Proxy
310+
match: connect${group}${version}Put(Namespaced)?${resource}Proxy
311+
- name: Replace Connect Proxy Path
312+
match: connect${group}${version}Put(Namespaced)?${resource}ProxyWithPath
313+
- name: Replace Proxy
314+
match: proxy${group}${version}PUT(Namespaced)?${resource}
315+
- name: Replace Proxy Path
316+
match: proxy${group}${version}PUT(Namespaced)?${resource}WithPath
317+
- name: "Misc Operations"
318+
default: true
319+
operation_types:
320+
- name: Read Scale
321+
match: read${group}${version}(Namespaced)?${resource}Scale
322+
- name: Replace Scale
323+
match: replace${group}${version}(Namespaced)?${resource}Scale
324+
- name: Patch Scale
325+
match: patch${group}${version}(Namespaced)?${resource}Scale
326+
- name: Rollback
327+
match: create${group}${version}(Namespaced)?${resource}Rollback
328+
- name: Read Log
329+
match: read${group}${version}(Namespaced)?${resource}Log
330+
- name: Get Connect Exec
331+
match: connect${group}${version}Get(Namespaced)?${resource}Exec
332+
- name: Create Connect Exec
333+
match: connect${group}${version}Post(Namespaced)?${resource}Exec
334+
- name: Get Connect Attach
335+
match: connect${group}${version}Get(Namespaced)?${resource}Attach
336+
- name: Create Connect Attach
337+
match: connect${group}${version}Post(Namespaced)?${resource}Attach
338+
339+
# List of *partial* operation IDs for matching. All matched operations are
340+
# excluded from the reference doc.
341+
excluded_operations:
342+
- connectCoreV1Patch
343+
- createCoreV1NamespacedPodBinding
344+
- getCodeVersion
345+
- logFileHandler
346+
- logFileListHandler
347+
- replaceCoreV1NamespaceFinalize
348+
- V1beta1CertificateSigningRequestApproval
349+
- V1CertificateSigningRequestApproval
350+
- V1beta1NamespacedReplicationControllerDummyScale
351+
- getServiceAccountIssuerOpenIDConfiguration
352+
- getServiceAccountIssuerOpenIDKeyset
353+
354+
# Map from group name to its full name
355+
group_full_names:
356+
admission: admission
357+
admissionregistration: admissionregistration.k8s.io
358+
apiextensions: apiextensions.k8s.io
359+
apiregistration: apiregistration.k8s.io
360+
apiserverinternal: internal.apiserver.k8s.io
361+
apps: apps
362+
authentication: authentication.k8s.io
363+
authorization: authorization.k8s.io
364+
autoscaling: autoscaling
365+
batch: batch
366+
certificates: certificates.k8s.io
367+
coordination: coordination.k8s.io
368+
core: core
369+
discovery: discovery.k8s.io
370+
events: events.k8s.io
371+
extensions: extensions
372+
flowcontrol: flowcontrol.apiserver.k8s.io
373+
meta: meta
374+
networking: networking.k8s.io
375+
node: node.k8s.io
376+
policy: policy
377+
rbac: rbac.authorization.k8s.io
378+
resource: resource.k8s.io
379+
scheduling: scheduling.k8s.io
380+
storage: storage.k8s.io
381+
storagemigration: storagemigration.k8s.io
382+
383+
# The map from the group as the resource sees it to the group as the operation
384+
# sees it.
385+
operation_group_map:
386+
rbac: RbacAuthorization
387+
flowcontrol: FlowcontrolApiserver
388+
apiserverinternal: InternalApiserver

0 commit comments

Comments
 (0)