feat: extended rh_templates to pass user validators to resthandler #1343
Conversation
|
This PR requires splunktaucclib in version 6.4 with the following changes: |
sgoral-splunk
changed the title
| for field in fields_content: | ||
| if field["field"] != "name": | ||
| fields.append( | ||
| RestFieldBuilder( |
There was a problem hiding this comment.
Pull building object up to for loop
| @@ -33,10 +33,14 @@ | |||
| class RestEntityBuilder: | |||
| _title_template = "[{}]" | |||
| _rh_template = """ | |||
| special_fields = [ | |||
There was a problem hiding this comment.
If special_fields are not present, can we omit this variable declaration?
There was a problem hiding this comment.
we can, but how do we benefit from it? I think it's not worth adding extra logic and template just to avoid declaring an empty list. What do you think about it?
| self, | ||
| name: Optional[str], | ||
| fields: List["RestFieldBuilder"], | ||
| special_fields: List["RestFieldBuilder"], |
There was a problem hiding this comment.
In splunktaucclib you had made this parameter of type Optional[List[RestField]] should we mention the same thing here.
| for field in self._fields: | ||
| field_line = field.generate_rh() | ||
| fields.append(field_line) | ||
| for special_field in self._special_fields: | ||
| field_line = special_field.generate_rh() |
There was a problem hiding this comment.
nit: I think here we can use list comprehension, or we can remove redundant variable declaration.
| @@ -14,6 +14,10 @@ | |||
| util.remove_http_proxy_env_vars() | |||
|
|
|||
|
|
|||
| special_fields = [ | |||
There was a problem hiding this comment.
Can we skip the declaration of special_fields if it is an empty list?
There was a problem hiding this comment.
like above: "we can, but how do we benefit from it? I think it's not worth adding extra logic and template just to avoid declaring an empty list. What do you think about it?"
Issue number:ADDON-74237
Summary
Extended rh_templates to pass user validators to resthandler
this pr requires changes from splunktauuclib: splunk/addonfactory-ucc-library#316
Changes
User experience
Name field will be validated with users validators, provided in the globalconfig, on the server side.
Checklist
If your change doesn't seem to apply, please leave them unchecked.