diff --git a/api/swagger.json b/api/swagger.json
index ed10cef2accb5e..83902932eae0e7 100644
--- a/api/swagger.json
+++ b/api/swagger.json
@@ -41,7 +41,13 @@
"responses": {
"200": {
"description": "successful operation",
- "content": "application/csv"
+ "content": {
+ "application/csv": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
}
}
}
@@ -55,7 +61,13 @@
"responses": {
"200": {
"description": "successful operation",
- "content": "application/json"
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
}
}
}
@@ -376,10 +388,10 @@
"name": "toolId",
"in": "path",
"example": "toolshed.g2.bx.psu.edu/repos/iuc/abricate/abricate",
- "description": "Tool ID WITHOUT the version component!!",
+ "description": "Tool ID WITHOUT the version component!! Also when you call it properly you do NOT need to encode the /.",
"required": true,
"schema": {
- "type": "string"
+ "type": "object"
}
}
],
diff --git a/faqs/galaxy/images/report_table_history_dataset_as_table.png b/faqs/galaxy/images/report_table_history_dataset_as_table.png
new file mode 100644
index 00000000000000..a0227bf6e88b8f
Binary files /dev/null and b/faqs/galaxy/images/report_table_history_dataset_as_table.png differ
diff --git a/faqs/galaxy/images/report_table_history_dataset_compact.png b/faqs/galaxy/images/report_table_history_dataset_compact.png
new file mode 100644
index 00000000000000..55bc6975961f2c
Binary files /dev/null and b/faqs/galaxy/images/report_table_history_dataset_compact.png differ
diff --git a/faqs/galaxy/images/report_table_history_dataset_display.png b/faqs/galaxy/images/report_table_history_dataset_display.png
new file mode 100644
index 00000000000000..54a8b5dff99614
Binary files /dev/null and b/faqs/galaxy/images/report_table_history_dataset_display.png differ
diff --git a/faqs/galaxy/images/report_table_history_dataset_embedded.png b/faqs/galaxy/images/report_table_history_dataset_embedded.png
new file mode 100644
index 00000000000000..8b39e32e1dc19b
Binary files /dev/null and b/faqs/galaxy/images/report_table_history_dataset_embedded.png differ
diff --git a/faqs/galaxy/images/report_table_history_dataset_title.png b/faqs/galaxy/images/report_table_history_dataset_title.png
new file mode 100644
index 00000000000000..13cb738d7e821b
Binary files /dev/null and b/faqs/galaxy/images/report_table_history_dataset_title.png differ
diff --git a/faqs/galaxy/reports_collapsible_box.md b/faqs/galaxy/reports_collapsible_box.md
new file mode 100644
index 00000000000000..62a08036fe7a7c
--- /dev/null
+++ b/faqs/galaxy/reports_collapsible_box.md
@@ -0,0 +1,18 @@
+---
+title: Making an element collapsible in a report
+description: If you have extraneous information you might want to let a user collapse it.
+area: reports
+box_type: tip
+layout: faq
+contributors: [hexylena, guerler]
+---
+
+This applies to any GalaxyMarkdown elements, i.e. the things you've clicked in the left panel to embed in your Workflow Report or Page
+
+By adding a `collapse=""` attribute to a markdown element, you can make it collapsible. Whatever you put in the quotes will be the title of the collapsible box.
+
+````markdown
+```
+history_dataset_type(history_dataset_id=3108c91feeb505da, collapse="[TITLE]")
+```
+````
diff --git a/faqs/galaxy/reports_tables.md b/faqs/galaxy/reports_tables.md
new file mode 100644
index 00000000000000..c8b6e9b2748af3
--- /dev/null
+++ b/faqs/galaxy/reports_tables.md
@@ -0,0 +1,92 @@
+---
+title: Enhancing tabular dataset previews in reports/pages
+description: There are lots of fun advanced features!
+area: reports
+box_type: tip
+layout: faq
+contributors: [jmchilton, hexylena]
+---
+
+There are a number of options, specifically for tabular data, that can allow it to render more nicely in your workflow reports and pages and anywhere that GalaxyMarkdown is used.
+
+- `title` to give your table a title
+- `footer` allows you to caption your table
+- `show_column_headers=false` to hide the column headers
+- `compact=true` to make the table show up more inline, hiding that it was embedded from a Galaxy dataset.
+
+The existing `history_dataset_display` directive displays the dataset name and some useful context at the expense of potentially breaking the flow of the document
+
+> Galaxy Markdown
+> ````markdown
+> ```galaxy
+> history_dataset_display(history_dataset_id=1e8ab44153008be8)
+> ```
+> ````
+{: .code-in}
+
+> Example Screenshot
+> 
+{: .code-out}
+
+
+The existing `history_dataset_embedded` directive was implemented to try to inline results more and make the results more readable within a more... curated document. It is dispatches on tabular types and puts the results in a table but the table doesn't have a lot of options.
+
+> Galaxy Markdown
+> ````markdown
+> ```galaxy
+> history_dataset_embedded(history_dataset_id=1e8ab44153008be8)
+> ```
+> ````
+{: .code-in}
+
+> Example Screenshot
+> 
+{: .code-out}
+
+
+The `history_dataset_as_table` directive mirrors the `history_dataset_as_image` directive: it tries harder to coerce the data into a table and provides new table—specific options. The first of these is "show_column_headers` which defaults to `true`.
+
+
+
+> Galaxy Markdown
+> ````markdown
+> ```galaxy
+> history_dataset_as_table(history_dataset_id=1e8ab44153008be8,show_column_headers=false)
+> ```
+> ````
+{: .code-in}
+
+> Example Screenshot
+> 
+{: .code-out}
+
+
+There is also a `compact` option. This provides a much more inline experience for tabular datasets:
+
+> Galaxy Markdown
+> ````markdown
+> ```galaxy
+> history_dataset_as_table(history_dataset_id=1e8ab44153008be8,show_column_headers=false,compact=true)
+> ```
+> ````
+{: .code-in}
+
+> Example Screenshot
+> 
+{: .code-out}
+
+
+Figures in general should have titles and legends — so there is the "title" and "footer" options also.
+
+> Galaxy Markdown
+> ````markdown
+> ```galaxy
+> history_dataset_as_table(history_dataset_id=1e8ab44153008be8,show_column_headers=false,title='Binding Site Results',footer='Here is a very good figure caption for this table.')
+> ```
+> ````
+{: .code-in}
+
+> Example Screenshot
+> 
+{: .code-out}
+
diff --git a/metadata/swagger.yaml b/metadata/swagger.yaml
index 2156405bc22b7b..5ebb6f74e05487 100644
--- a/metadata/swagger.yaml
+++ b/metadata/swagger.yaml
@@ -29,7 +29,9 @@ paths:
200:
description: successful operation
content:
- application/csv
+ application/csv:
+ schema:
+ type: string
/feedback.json:
get:
tags:
@@ -39,7 +41,9 @@ paths:
200:
description: successful operation
content:
- application/json
+ application/json:
+ schema:
+ type: string
/contributors.json:
get:
tags:
@@ -249,7 +253,7 @@ paths:
description: Tool ID WITHOUT the version component!! Also when you call it properly you do NOT need to encode the /.
required: true
schema:
- type: string
+ type: object
summary: Get the GTN's public server tool listing for a specific tool ID. It lists all known public servers that are reachable at the time of the GTN's deployment, and which versions of this tool are available. It's very important that you strip the version component!
responses:
200:
diff --git a/topics/galaxy-interface/tutorials/workflow-reports/tutorial.md b/topics/galaxy-interface/tutorials/workflow-reports/tutorial.md
index 42fa00f18eb036..5dfdd4f35f5664 100644
--- a/topics/galaxy-interface/tutorials/workflow-reports/tutorial.md
+++ b/topics/galaxy-interface/tutorials/workflow-reports/tutorial.md
@@ -319,7 +319,11 @@ Well done! You have created a customized workflow report with text and workflow
- peeks into dataset (useful for large files that cannot be included in their entirety in the report)
- ..and more!
+## Make your reports nicer!
+{% snippet faqs/galaxy/reports_tables.md %}
+
+{% snippet faqs/galaxy/reports_collapsible_box.md %}
# Share or publish your workflow report