Skip to content

Commit 6eb49d6

Browse files
committed
Fix field name to 'required` of ConfigurationParameterDescriptor
The TSP specifies `required` instead of `isRequired`. This commit aligns the implementation with the specification. See also: eclipse-tracecompass-incubator/org.eclipse.tracecompass.incubator#246 Signed-off-by: Bernd Hufmann <[email protected]>
1 parent cd3f493 commit 6eb49d6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

tsp/configuration_parameter_descriptor.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
KEY_NAME_KEY = "keyName"
2828
DESCTIPION_KEY = "description"
2929
DATA_TYPE_KEY = "dataType"
30-
REQUIRED_KEY = "isRequired"
30+
REQUIRED_KEY = "required"
3131

3232
# pylint: disable=too-few-public-methods
3333
class ConfigurationParameterDescriptor:
@@ -60,14 +60,14 @@ def __init__(self, params):
6060

6161
if REQUIRED_KEY in params:
6262
# pylint: disable=invalid-name
63-
self.is_required = params.get(REQUIRED_KEY)
63+
self.required = params.get(REQUIRED_KEY)
6464
del params[REQUIRED_KEY]
6565
else:
66-
self.is_required = "false"
66+
self.required = "false"
6767

6868
def __repr__(self):
69-
return 'ConfigurationParameterDescriptor[key_name={}, description={}, data_type={}, is_required={}])'.format(
70-
self.key_name,self.description, self.data_type, self.is_required)
69+
return 'ConfigurationParameterDescriptor[key_name={}, description={}, data_type={}, required={}])'.format(
70+
self.key_name,self.description, self.data_type, self.required)
7171

7272
def to_json(self):
7373
return (json.dumps(self, cls=ConfigurationParameterDescriptorEncoder, indent=4))
@@ -80,6 +80,6 @@ def default(self, obj):
8080
KEY_NAME_KEY: obj.key_name,
8181
DESCTIPION_KEY: obj.description,
8282
DATA_TYPE_KEY: obj.data_type,
83-
REQUIRED_KEY: obj.is_required
83+
REQUIRED_KEY: obj.required
8484
}
8585
return super().default(obj)

0 commit comments

Comments
 (0)