You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: v2/azure-arm.yaml
+9
Original file line number
Diff line number
Diff line change
@@ -895,6 +895,9 @@ status:
895
895
# Set to 'false' to disable our heuristics if a property is incorrectly
896
896
# identified as an ARM reference.
897
897
#
898
+
# $description: <string>
899
+
# Overrides the property description with the provided value.
900
+
#
898
901
# $importConfigMapMode: <optional|required>
899
902
# Specifies that the property can be imported from a config map.
900
903
# Optional: The property may be specified as string or imported from a config map.
@@ -3104,6 +3107,9 @@ objectModelConfiguration:
3104
3107
VirtualNetworks_Subnet: # TODO: There must always be a parent and child in the same API version. See https://github.com/Azure/azure-service-operator/issues/3002
3105
3108
$exportAs: VirtualNetworksSubnet
3106
3109
$supportedFrom: v2.0.0-alpha.1
3110
+
VirtualNetworksSubnet_STATUS:
3111
+
IpConfigurations:
3112
+
$description: "An array of references to the network interface IP configurations using subnet. This field is not included if there are more than 2000 entries."
3107
3113
VirtualNetworks_VirtualNetworkPeering:
3108
3114
$exportAs: VirtualNetworksVirtualNetworkPeering
3109
3115
$supportedFrom: v2.0.0-alpha.1
@@ -3409,6 +3415,9 @@ objectModelConfiguration:
3409
3415
VirtualNetworks_Subnet: # TODO: There must always be a parent and child in the same API version. See https://github.com/Azure/azure-service-operator/issues/3002
3410
3416
$exportAs: VirtualNetworksSubnet
3411
3417
$supportedFrom: v2.11.0
3418
+
VirtualNetworksSubnet_STATUS:
3419
+
IpConfigurations:
3420
+
$description: "An array of references to the network interface IP configurations using subnet. This field is not included if there are more than 2000 entries."
Copy file name to clipboardexpand all lines: v2/tools/generator/internal/codegen/testdata/TestGolden_NewARMCodeGeneratorFromConfigCreatesRightPipeline.golden
+1
Original file line number
Diff line number
Diff line change
@@ -47,6 +47,7 @@ applyKubernetesResourceInterface azure Add the KubernetesR
47
47
flattenProperties Apply flattening to properties marked for flattening
48
48
stripUnreferenced Strip unreferenced types
49
49
renameProperties Rename properties
50
+
overrideDescriptions Applies the configured description overrides
50
51
addStatusConditions azure Add the property 'Conditions' to all status types and implements genruntime.Conditioner on all resources
51
52
addOperatorSpec azure Adds the property 'OperatorSpec' to all Spec types that require it
52
53
addKubernetesExporter azure Adds the KubernetesExporter interface to resources that need it
Copy file name to clipboardexpand all lines: v2/tools/generator/internal/codegen/testdata/TestGolden_NewCrossplaneCodeGeneratorFromConfigCreatesRightPipeline.golden
+1
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,7 @@ addSerializationTypeTag Adds a property tag to p
37
37
flattenProperties Apply flattening to properties marked for flattening
38
38
stripUnreferenced Strip unreferenced types
39
39
renameProperties Rename properties
40
+
overrideDescriptions Applies the configured description overrides
40
41
addCrossplaneOwnerProperties crossplane Add the 3-tuple of (xName, xNameRef, xNameSelector) for each owning resource
41
42
addCrossplaneForProviderProperty crossplane Add a 'ForProvider' property on every spec
42
43
addCrossplaneAtProviderProperty crossplane Add an 'AtProvider' property on every status
Copy file name to clipboardexpand all lines: v2/tools/generator/internal/config/property_configuration.go
+15
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,7 @@ type PropertyConfiguration struct {
24
24
namestring
25
25
// Configurable properties here (alphabetical, please)
26
26
ARMReferenceconfigurable[bool] // Specify whether this property is an ARM reference
27
+
Descriptionconfigurable[string] // Specify a description override for this property
27
28
ImportConfigMapModeconfigurable[ImportConfigMapMode] // The config map mode
28
29
IsSecretconfigurable[bool] // Specify whether this property is a secret
29
30
NameInNextVersionconfigurable[string] // Name this property has in the next version
@@ -42,6 +43,7 @@ const (
42
43
// Tags used in yaml files to specify configurable properties. Alphabetical please.
43
44
const (
44
45
armReferenceTag="$armReference"// Bool specifying whether a property is an ARM reference
46
+
descriptionTag="$description"// String overriding the properties default description
45
47
exportAsConfigMapPropertyNameTag="$exportAsConfigMapPropertyName"// String specifying the name of the property set to export this property as a config map.
46
48
importConfigMapModeTag="$importConfigMapMode"// string specifying the ImportConfigMapMode mode
47
49
isSecretTag="$isSecret"// Bool specifying whether a property contains a secret
0 commit comments