kubectl/pkg/explain
Predrag Knezevic c04eeb90aa kubectl explain: render externalDocs from OpenAPI v3 schemas
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
2026-02-11 13:01:38 +01:00
..
v2 kubectl explain: render externalDocs from OpenAPI v3 schemas 2026-02-11 13:01:38 +01:00
explain.go Add jsonpath support for explain 2023-02-11 15:10:40 -08:00
explain_test.go Add more tests that should exist but don't for some reason 2023-02-13 10:30:41 -08:00
field_lookup.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
field_lookup_test.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
fields_printer.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
fields_printer_builder.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
fields_printer_test.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
formatter.go clean true judge 2021-04-27 20:11:36 +08:00
formatter_test.go Replace apimachinery diff.StringDiff with cmp 2023-03-23 11:10:32 -07:00
model_printer.go Fix printing control character in kubectl explain 2022-01-20 15:04:15 +01:00
model_printer_test.go Fix printing control character in kubectl explain 2022-01-20 15:04:15 +01:00
OWNERS Check in OWNERS modified by update-yamlfmt.sh 2021-12-09 21:31:26 -05:00
recursive_fields_printer.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
recursive_fields_printer_test.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
test-recursive-swagger.json Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
test-swagger.json Fix printing control character in kubectl explain 2022-01-20 15:04:15 +01:00
typename.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00
typename_test.go Move pkg/kubect/explain to staging 2019-07-29 14:57:41 -07:00