Skip to content

Commit ea728e4

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request kubernetes-sigs#325 from tengqm/apiref-128
Update API reference generator for 1.28
2 parents 7f83d75 + af055a4 commit ea728e4

File tree

5 files changed

+75229
-26
lines changed

5 files changed

+75229
-26
lines changed

‎gen-apidocs/config/v1_28/config.yaml

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

0 commit comments

Comments
 (0)