tools/config-crd-ref-docs.yaml

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

##
# The configuration file for the crd-ref-docs tool. This tool generates API
# documentation in markdown for the AuthProxyWorkload CRD from the go source
# code. See the make target `generate_crd_docs`.

processor:
  # Ignore lists and status entities. We don't need to include those in the doc
  ignoreTypes:
    - "(AuthProxyWorkload)List$"
    - "(AuthProxyWorkload)Status$"
  # Ignore status TypeMeta fields
  ignoreFields:
    - "status$"
    - "TypeMeta$"
    # skip debug fields on AuthProxyContainerSpec
    - "^Container$"
    - "^SQLAdminAPIEndpoint"
  useRawDocstring: false
render:
  # Version of Kubernetes to use when generating links to Kubernetes API documentation.
  kubernetesVersion: 1.24