Adding Tag decorator

beer-garden · Dec 4, 2023 · 964c61f · 964c61f
1 parent 83ec1cf
commit 964c61f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/brewtils/decorators.py b/brewtils/decorators.py
@@ -90,6 +90,7 @@ def command(
     icon_name=None,  # type: Optional[str]
     hidden=False,  # type: Optional[bool]
     metadata=None,  # type: Optional[Dict]
+    tags=None, # type: Optional[List[str]]
     allow_any_kwargs=None,  # type: Optional[bool]
 ):
     """Decorator for specifying Command details
@@ -119,6 +120,7 @@ def echo_json(self, message):
         icon_name: The icon name. Should be either a FontAwesome or a Glyphicon name.
         hidden: Flag controlling whether the command is visible on the user interface.
         metadata: Free-form dictionary
+        tags: A list of tags that can be used to filter commands
         allow_any_kwargs: Flag controlling whether passed kwargs will be restricted to
             the Command parameters defined.
 
@@ -156,6 +158,7 @@ def echo_json(self, message):
             icon_name=icon_name,
             hidden=hidden,
             metadata=metadata,
+            tags=tags,
             allow_any_kwargs=allow_any_kwargs,
         )
 
@@ -178,6 +181,7 @@ def echo_json(self, message):
         icon_name=icon_name,
         hidden=hidden,
         metadata=metadata,
+        tags=tags,
         allow_any_kwargs=allow_any_kwargs,
     )
 

diff --git a/brewtils/models.py b/brewtils/models.py
@@ -119,6 +119,7 @@ def __init__(
         icon_name=None,
         hidden=False,
         metadata=None,
+        tags=None,
         topics=None,
         allow_any_kwargs=None,
     ):
@@ -133,6 +134,7 @@ def __init__(
         self.icon_name = icon_name
         self.hidden = hidden
         self.metadata = metadata or {}
+        self.tags = tags or []
         self.topics = topics or []
         self.allow_any_kwargs = allow_any_kwargs
 

diff --git a/brewtils/schemas.py b/brewtils/schemas.py
@@ -221,6 +221,7 @@ class CommandSchema(BaseSchema):
     icon_name = fields.Str(allow_none=True)
     hidden = fields.Boolean(allow_none=True)
     metadata = fields.Dict(allow_none=True)
+    tags = fields.List(fields.Str(), allow_none=True)
     topics = fields.List(fields.Str(), allow_none=True)
     allow_any_kwargs = fields.Boolean(allow_none=True)
 

diff --git a/brewtils/test/fixtures.py b/brewtils/test/fixtures.py
@@ -170,6 +170,7 @@ def command_dict(parameter_dict, system_id):
         "template": "<html></html>",
         "icon_name": "icon!",
         "metadata": {"meta": "data"},
+        "tags": [],
         "topics": [],
         "allow_any_kwargs": False,
     }