Skip to content

Commit

Permalink
Automatic upate of README.md by arcaflow-docsgen arcabot
Browse files Browse the repository at this point in the history
  • Loading branch information
arcalot-bot committed Jan 16, 2024
1 parent 15be190 commit 49f3a3b
Showing 1 changed file with 80 additions and 11 deletions.
91 changes: 80 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,19 @@ Load data into opensearch compatible instance
### Input

<table><tbody>
<tr><th>Type:</th><td><code>scope</code></td><tr><th>Root object:</th><td>StoreDocumentRequest</td></tr>
<tr><th>Properties</th><td><details><summary>data (<code>map[<code>string</code>, <code>
<tr><th>Type:</th><td><code>scope</code></td><tr><th>Root object:</th><td>DocumentRequest</td></tr>
<tr><th>Properties</th><td><details><summary>bulk_upload_list (<code>list[<code>reference[BulkUploadObject]</code>]</code>)</summary>
<table><tbody><tr><th>Name:</th><td>bulk upload list</td></tr><tr><th>Description:</th><td>The list of objects for the bulk upload operation.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>list[<code>reference[BulkUploadObject]</code>]</code></td><tr><td colspan="2">
<details>
<summary>List items</summary>
<table><tbody><tr><th>Type:</th><td><code>reference[BulkUploadObject]</code></td><tr><th>Referenced object:</th><td>BulkUploadObject</td></tr></tbody></table>
</details>
</td></tr></tbody></table>
</details><details><summary>default_index (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>index</td></tr><tr><th>Description:</th><td>Name of the default index that will receive the data.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>string</code></td><tr><th>Minimum length:</th><td>1</td></tr></tbody></table>
</details><details><summary>metadata (<code>map[<code>string</code>, <code>
any</code>]</code>)</summary>
<table><tbody><tr><th>Name:</th><td>data</td></tr><tr><th>Description:</th><td>Data to upload to your index</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>map[<code>string</code>, <code>
<table><tbody><tr><th>Name:</th><td>metadata</td></tr><tr><th>Description:</th><td>Optional global metadata object that will be added to every document.</td></tr><tr><th>Required:</th><td>No</td></tr><tr><th>Type:</th><td><code>map[<code>string</code>, <code>
any</code>]</code></td><tr><td colspan="2">
<details>
<summary>Key type</summary>
Expand All @@ -73,8 +82,6 @@ Load data into opensearch compatible instance
</details>
</td></tr>
</tbody></table>
</details><details><summary>index (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>index</td></tr><tr><th>Description:</th><td>Name of the index that will receive the data.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>string</code></td><tr><th>Minimum length:</th><td>1</td></tr></tbody></table>
</details><details><summary>password (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>password</td></tr><tr><th>Description:</th><td>The password for the given user.</td></tr><tr><th>Required:</th><td>No</td></tr><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details><details><summary>tls_verify (<code>bool</code>)</summary>
Expand All @@ -84,10 +91,60 @@ Load data into opensearch compatible instance
</details><details><summary>username (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>username</td></tr><tr><th>Description:</th><td>A username for an authorized user for the given Opensearch-compatible instance.</td></tr><tr><th>Required:</th><td>No</td></tr><tr><th>Type:</th><td><code>string</code></td><tr><th>Minimum length:</th><td>1</td></tr></tbody></table>
</details></td></tr>
<tr><td colspan="2"><details><summary><strong>Objects</strong></summary><details><summary>StoreDocumentRequest (<code>object</code>)</summary>
<tr><td colspan="2"><details><summary><strong>Objects</strong></summary><details><summary>BulkUploadObject (<code>object</code>)</summary>
<table><tbody><tr><th>Type:</th><td><code>object</code></td><tr><th>Properties</th><td><details><summary>data (<code>map[<code>string</code>, <code>
any</code>]</code>)</summary>
<table><tbody><tr><th>Name:</th><td>data</td></tr><tr><th>Description:</th><td>Data to upload to your index</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>map[<code>string</code>, <code>
<table><tbody><tr><th>Name:</th><td>data</td></tr><tr><th>Description:</th><td>The JSON data document to upload to your index.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>map[<code>string</code>, <code>
any</code>]</code></td><tr><td colspan="2">
<details>
<summary>Key type</summary>
<table><tbody><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details>
</td></tr>
<tr><td colspan="2">
<details>
<summary>Value type</summary>
<table><tbody><tr><th>Type:</th><td><code>
any</code></td></tbody></table>
</details>
</td></tr>
</tbody></table>
</details><details><summary>operation (<code>map[<code>string</code>, <code>reference[BulkUploadOperationMeta]</code>]</code>)</summary>
<table><tbody><tr><th>Name:</th><td>operation</td></tr><tr><th>Description:</th><td>The operation type and associated operation metadata.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>map[<code>string</code>, <code>reference[BulkUploadOperationMeta]</code>]</code></td><tr><td colspan="2">
<details>
<summary>Key type</summary>
<table><tbody><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details>
</td></tr>
<tr><td colspan="2">
<details>
<summary>Value type</summary>
<table><tbody><tr><th>Type:</th><td><code>reference[BulkUploadOperationMeta]</code></td><tr><th>Referenced object:</th><td>BulkUploadOperationMeta</td></tr></tbody></table>
</details>
</td></tr>
</tbody></table>
</details></td></tr>
</tbody></table>
</details><details><summary>BulkUploadOperationMeta (<code>object</code>)</summary>
<table><tbody><tr><th>Type:</th><td><code>object</code></td><tr><th>Properties</th><td><details><summary>_id (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>ID</td></tr><tr><th>Description:</th><td>Optional ID for the data document.</td></tr><tr><th>Required:</th><td>No</td></tr><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details><details><summary>_index (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>index</td></tr><tr><th>Description:</th><td>Optional name of the index that will receive the data. If none is provided, the default index will be used.</td></tr><tr><th>Required:</th><td>No</td></tr><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details></td></tr>
</tbody></table>
</details><details><summary>DocumentRequest (<code>object</code>)</summary>
<table><tbody><tr><th>Type:</th><td><code>object</code></td><tr><th>Properties</th><td><details><summary>bulk_upload_list (<code>list[<code>reference[BulkUploadObject]</code>]</code>)</summary>
<table><tbody><tr><th>Name:</th><td>bulk upload list</td></tr><tr><th>Description:</th><td>The list of objects for the bulk upload operation.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>list[<code>reference[BulkUploadObject]</code>]</code></td><tr><td colspan="2">
<details>
<summary>List items</summary>
<table><tbody><tr><th>Type:</th><td><code>reference[BulkUploadObject]</code></td><tr><th>Referenced object:</th><td>BulkUploadObject</td></tr></tbody></table>
</details>
</td></tr></tbody></table>
</details><details><summary>default_index (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>index</td></tr><tr><th>Description:</th><td>Name of the default index that will receive the data.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>string</code></td><tr><th>Minimum length:</th><td>1</td></tr></tbody></table>
</details><details><summary>metadata (<code>map[<code>string</code>, <code>
any</code>]</code>)</summary>
<table><tbody><tr><th>Name:</th><td>metadata</td></tr><tr><th>Description:</th><td>Optional global metadata object that will be added to every document.</td></tr><tr><th>Required:</th><td>No</td></tr><tr><th>Type:</th><td><code>map[<code>string</code>, <code>
any</code>]</code></td><tr><td colspan="2">
<details>
<summary>Key type</summary>
Expand All @@ -102,8 +159,6 @@ Load data into opensearch compatible instance
</details>
</td></tr>
</tbody></table>
</details><details><summary>index (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>index</td></tr><tr><th>Description:</th><td>Name of the index that will receive the data.</td></tr><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>string</code></td><tr><th>Minimum length:</th><td>1</td></tr></tbody></table>
</details><details><summary>password (<code>string</code>)</summary>
<table><tbody><tr><th>Name:</th><td>password</td></tr><tr><th>Description:</th><td>The password for the given user.</td></tr><tr><th>Required:</th><td>No</td></tr><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details><details><summary>tls_verify (<code>bool</code>)</summary>
Expand Down Expand Up @@ -139,11 +194,25 @@ Load data into opensearch compatible instance

<table><tbody>
<tr><th>Type:</th><td><code>scope</code></td><tr><th>Root object:</th><td>SuccessOutput</td></tr>
<tr><th>Properties</th><td><details><summary>message (<code>string</code>)</summary>
<tr><th>Properties</th><td><details><summary>document_ids (<code>list[<code>string</code>]</code>)</summary>
<table><tbody><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>list[<code>string</code>]</code></td><tr><td colspan="2">
<details>
<summary>List items</summary>
<table><tbody><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details>
</td></tr></tbody></table>
</details><details><summary>message (<code>string</code>)</summary>
<table><tbody><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details></td></tr>
<tr><td colspan="2"><details><summary><strong>Objects</strong></summary><details><summary>SuccessOutput (<code>object</code>)</summary>
<table><tbody><tr><th>Type:</th><td><code>object</code></td><tr><th>Properties</th><td><details><summary>message (<code>string</code>)</summary>
<table><tbody><tr><th>Type:</th><td><code>object</code></td><tr><th>Properties</th><td><details><summary>document_ids (<code>list[<code>string</code>]</code>)</summary>
<table><tbody><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>list[<code>string</code>]</code></td><tr><td colspan="2">
<details>
<summary>List items</summary>
<table><tbody><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details>
</td></tr></tbody></table>
</details><details><summary>message (<code>string</code>)</summary>
<table><tbody><tr><th>Required:</th><td>Yes</td></tr><tr><th>Type:</th><td><code>string</code></td></tbody></table>
</details></td></tr>
</tbody></table>
Expand Down

0 comments on commit 49f3a3b

Please sign in to comment.