Sub Description
This feature allows us to pass a broader description on the Input and Configuration pages displayed under main description.
Sub Descritpion Properties
Property |
Type |
Description |
text* |
string |
is text used for the description, you can put \n to add a breakline. |
links |
object |
enables including links inside description |
Links
Property |
Type |
Description |
slug* |
string |
is used to identify the place for the link to appear. Put it inside the text, surrounded by 2 squared brackets. |
link* |
string |
is the link to be used. |
linkText* |
string |
is the text to be inserted, instead of slug. |
Usage
{
"name": "example_input_one",
"title": "Example Input One",
"entity": [],
"subDescription": {
"text": "Ingesting data from to Splunk Cloud?\nRead our [[blogPost]] to learn more about Data Manager and it's availability on your Splunk Cloud instance.",
"links": [
{
"slug": "blogPost",
"link": "https://splk.it/31oy2b2",
"linkText": "blog post"
}
]
}
}