github.com/TheSpiritXIII/controller-tools@v0.14.1/pkg/schemapatcher/zz_generated.markerhelp.go (about)

     1  //go:build !ignore_autogenerated
     2  
     3  /*
     4  Copyright2019 The Kubernetes Authors.
     5  
     6  Licensed under the Apache License, Version 2.0 (the "License");
     7  you may not use this file except in compliance with the License.
     8  You may obtain a copy of the License at
     9  
    10      http://www.apache.org/licenses/LICENSE-2.0
    11  
    12  Unless required by applicable law or agreed to in writing, software
    13  distributed under the License is distributed on an "AS IS" BASIS,
    14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    15  See the License for the specific language governing permissions and
    16  limitations under the License.
    17  */
    18  
    19  // Code generated by helpgen. DO NOT EDIT.
    20  
    21  package schemapatcher
    22  
    23  import (
    24  	"github.com/TheSpiritXIII/controller-tools/pkg/markers"
    25  )
    26  
    27  func (Generator) Help() *markers.DefinitionHelp {
    28  	return &markers.DefinitionHelp{
    29  		Category: "",
    30  		DetailedHelp: markers.DetailedHelp{
    31  			Summary: "patches existing CRDs with new schemata.",
    32  			Details: "It will generate output for each \"CRD Version\" (API version of the CRD type\nitself) , e.g. apiextensions/v1) available.",
    33  		},
    34  		FieldHelp: map[string]markers.DetailedHelp{
    35  			"ManifestsPath": {
    36  				Summary: "contains the CustomResourceDefinition YAML files.",
    37  				Details: "",
    38  			},
    39  			"MaxDescLen": {
    40  				Summary: "specifies the maximum description length for fields in CRD's OpenAPI schema.",
    41  				Details: "0 indicates drop the description for all fields completely.\nn indicates limit the description to at most n characters and truncate the description to\nclosest sentence boundary if it exceeds n characters.",
    42  			},
    43  			"GenerateEmbeddedObjectMeta": {
    44  				Summary: "specifies if any embedded ObjectMeta in the CRD should be generated",
    45  				Details: "",
    46  			},
    47  		},
    48  	}
    49  }