k8s.io/kube-openapi@v0.0.0-20240228011516-70dd3763d340/pkg/idl/structtype_test.go (about)

     1  /*
     2  Copyright 2018 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package idl_test
    18  
    19  // This example shows how to use the structType atomic attribute to
    20  // specify that this struct should be treated as a whole.
    21  func ExampleStructType_atomic() {
    22  	type SomeStruct struct {
    23  		Name  string
    24  		Value string
    25  	}
    26  	type SomeAPI struct {
    27  		// +structType=atomic
    28  		elements SomeStruct
    29  	}
    30  }