Merge pull request #16769 from martenson/tags-openapi

provide specific example for API docs - tags
galaxyproject · Sep 30, 2023 · 486b802 · 486b802
2 parents d7cc3e8 + 214da61
commit 486b802
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/client/src/schema/schema.ts b/client/src/schema/schema.ts
@@ -8667,6 +8667,11 @@ export interface components {
         /**
          * TagCollection
          * @description The collection of tags associated with an item.
+         * @example [
+         *   "COVID-19",
+         *   "#myFancyTag",
+         *   "covid19.galaxyproject.org"
+         * ]
          */
         TagCollection: string[];
         /**

diff --git a/lib/galaxy/schema/schema.py b/lib/galaxy/schema/schema.py
@@ -504,6 +504,7 @@ class TagCollection(Model):
         default=...,
         title="Tags",
         description="The collection of tags associated with an item.",
+        example=["COVID-19", "#myFancyTag", "covid19.galaxyproject.org"],
     )