@redpanda-data/docs-extensions-and-macros 4.15.6 → 4.15.8

package/tools/redpanda-connect/templates/bloblang-function.hbs

@@ -1,15 +1,41 @@
 // This content is autogenerated. Do not edit manually. To override descriptions, use the doc-tools CLI with the --overrides option: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1247543314/Generate+reference+docs+for+Redpanda+Connect
 
 = {{name}}
-
 {{#if signature}}
+
 *Signature*: `{{signature}}`
 {{/if}}
+{{#if (eq status "deprecated")}}
 
+[WARNING]
+====
+This {{#if signature}}function{{else}}method{{/if}} is deprecated and will be removed in a future version.
+====
+{{/if}}
 {{#if description}}
-{{description}}
+
+{{{ensurePeriod description}}}
 {{/if}}
 
+{{#if params}}
+{{#if params.named}}
+
+== Parameters
+
+[cols="1,1,3"]
+|===
+| Name | Type | Description
+
+{{#each params.named}}
+| `{{name}}`{{#if is_optional}} (optional){{/if}}
+| `{{type}}`
+| {{{description}}}
+
+{{/each}}
+|===
+
+{{/if}}
+{{/if}}
 
 {{#if examples}}
 == Examples

package/tools/redpanda-connect/templates/bloblang-functions-overview.hbs

@@ -0,0 +1,29 @@
+= Bloblang Functions
+// tag::single-source[]
+:description: A list of Bloblang functions
+
+// © 2024 Redpanda Data Inc.
+
+
+Functions can be placed anywhere and allow you to extract information from your environment, generate values, or access data from the underlying message being mapped:
+
+```bloblang
+root.doc.id = uuid_v4()
+root.doc.received_at = now()
+root.doc.host = hostname()
+```
+
+Functions support both named and nameless style arguments:
+
+```bloblang
+root.values_one = range(start: 0, stop: this.max, step: 2)
+root.values_two = range(0, this.max, 2)
+
+# In:  {"max":10}
+```
+{{#each functions}}
+
+include::redpanda-connect:components:partial$bloblang-functions/{{this}}.adoc[leveloffset=+1]
+{{/each}}
+
+// end::single-source[]

package/tools/redpanda-connect/templates/bloblang-methods-overview.hbs

@@ -0,0 +1,39 @@
+= Bloblang Methods
+// tag::single-source[]
+:description: A list of Bloblang methods
+
+// © 2024 Redpanda Data Inc.
+
+
+Methods provide most of the power in Bloblang as they allow you to augment values and can be added to any expression (including other methods):
+
+```bloblang
+root.doc.id = this.thing.id.string().catch(uuid_v4())
+root.doc.reduced_nums = this.thing.nums.map_each(num -> if num < 10 {
+  deleted()
+} else {
+  num - 10
+})
+root.has_good_taste = ["pikachu","mewtwo","magmar"].contains(this.user.fav_pokemon)
+
+# In:  {"thing":{"id":123,"nums":[5,12,18,7,25]},"user":{"fav_pokemon":"pikachu"}}
+```
+
+Methods support both named and nameless style arguments:
+
+```bloblang
+root.foo_one = this.(bar | baz).trim().replace_all(old: "dog", new: "cat")
+root.foo_two = this.(bar | baz).trim().replace_all("dog", "cat")
+
+# In:  {"bar":"  I love my dog  "}
+```
+{{#each categories}}
+
+== {{{toSentenceCase this.name}}}
+{{#each this.methods}}
+
+include::redpanda-connect:components:partial$bloblang-methods/{{this}}.adoc[leveloffset=+2]
+{{/each}}
+{{/each}}
+
+// end::single-source[]

package/tools/redpanda-connect/templates/connector.hbs

@@ -1,9 +1,9 @@
 = {{{name}}}
 // tag::single-source[]
 :type: {{type}}
-:status: {{status}}
+{{#if support}}:support: {{support}}{{/if}}
 :categories: [{{join categories ", "}}]
-:description: {{#if summary}}{{{summary}}}{{else if description}}{{description}}{{else}}TODO: Missing description. Add a description in the overrides file or source data.{{/if}}
+:description: {{#if summary}}{{{summary}}}{{else if description}}{{description}}{{else}}// TODO: Missing description. Add a description in the overrides file or source data.{{/if}}
 
 component_type_dropdown::[]
 

package/tools/redpanda-connect/templates/intro.hbs

@@ -9,5 +9,5 @@ endif::[]
 {{#if description}}
 {{{description}}}
 {{else}}
-TODO: Missing description. Add a description in the overrides file or source data.
+// TODO: Missing description. Add a description in the overrides file or source data.
 {{/if}}