mirror of
https://github.com/kubernetes/kubectl.git
synced 2026-04-06 01:24:56 -04:00
CRD authors can set the externalDocs field in their [OpenAPI v3 schemas](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) to reference external documentation for their custom resources. However, kubectl explain did not surface this information to users. Render externalDocs metadata in the plaintext output of kubectl explain. When a schema or field includes an externalDocs section, it is now displayed as: ``` EXTERNAL DOCS: <description> URL: <url> ``` This appears after the DESCRIPTION block for top-level resources and after the field description for individual fields. The section is omitted in short mode and when externalDocs is absent. Kubernetes-commit: 7d855871267a3a9698af2862c79ebb7d4d2ec308 |
||
|---|---|---|
| .. | ||
| v2 | ||
| explain.go | ||
| explain_test.go | ||
| field_lookup.go | ||
| field_lookup_test.go | ||
| fields_printer.go | ||
| fields_printer_builder.go | ||
| fields_printer_test.go | ||
| formatter.go | ||
| formatter_test.go | ||
| model_printer.go | ||
| model_printer_test.go | ||
| OWNERS | ||
| recursive_fields_printer.go | ||
| recursive_fields_printer_test.go | ||
| test-recursive-swagger.json | ||
| test-swagger.json | ||
| typename.go | ||
| typename_test.go | ||