k8s.io/kube-openapi@v0.0.0-20240228011516-70dd3763d340/pkg/idl/listtype_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 listType map attribute and how to
    20  // specify a key to identify elements of the list. The listMapKey
    21  // attribute is used to specify that Name is the key of the map.
    22  func ExampleListType_map() {
    23  	type SomeStruct struct {
    24  		Name  string
    25  		Value string
    26  	}
    27  	type SomeAPI struct {
    28  		// +listType=map
    29  		// +listMapKey=name
    30  		elements []SomeStruct
    31  	}
    32  }
    33  
    34  // This example shows how to use the listType set attribute to specify
    35  // that this list should be treated as a set: items in the list can't be
    36  // duplicated.
    37  func ExampleListType_set() {
    38  	type SomeAPI struct {
    39  		// +listType=set
    40  		keys []string
    41  	}
    42  }
    43  
    44  // This example shows how to use the listType atomic attribute to
    45  // specify that this list should be treated as a whole.
    46  func ExampleListType_atomic() {
    47  	type SomeStruct struct {
    48  		Name  string
    49  		Value string
    50  	}
    51  
    52  	type SomeAPI struct {
    53  		// +listType=atomic
    54  		elements []SomeStruct
    55  	}
    56  }