search

kubernetes-sigs / reference-docs

Tools to build reference documentation for Kubernetes APIs and CLIs.
Apache License 2.0
87 stars 102 forks source link

Support referenced parameters #324

Closed feloy closed 1 year ago

feloy commented 1 year ago

Kubernetes v1.28 spec introduces the use of referenced Parameters:

        "parameters": [
          {
-            "in": "body",
-            "name": "body",
-            "schema": {
-              "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions"
+            "$ref": "#/parameters/body-2Y1dVQaQ"
            }
          },

The changes in this PR makes the converter able to get the parameter information from the referenced parameter.

This change is necessary to build the multi-pages API reference for Kubernetes v1.28

tengqm commented 1 year ago

/approve

k8s-ci-robot commented 1 year ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: feloy, tengqm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/reference-docs/blob/master/OWNERS)~~ [feloy,tengqm] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
tengqm commented 1 year ago

/lgtm