github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2026-01-05 15:37:24 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #114948 from haoruan/feature-api-doc-field-linter

Browse Source 
Add linter to check if api docs match field tag names
This commit is contained in:
Kubernetes Prow Robot
2023-01-30 16:21:09 -08:00
committed by GitHub
parent 3d0894fabf 08210a1cb5
commit 5d4776adc1
7 changed files with 182 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api/openapi-spec/v3/apis__apiextensions.k8s.io__v1_openapi.json
View File

@@ -45,7 +45,7 @@
"properties": {
"strategy": {
"default": "",
"description": "strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information\n is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.",
"description": "strategy specifies how custom resources are converted between versions. Allowed values are: - `\"None\"`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `\"Webhook\"`: API Server will call to an external webhook to do the conversion. Additional information\n is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set.",
"type": "string"
},
"webhook": {
@@ -54,7 +54,7 @@
"$ref": "#/components/schemas/io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion"
}
],
"description": "webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`."
"description": "webhook describes how to call the conversion webhook. Required when `strategy` is set to `\"Webhook\"`."
}
},
"required": [