From 49f3a3bf4937bd563b4ced6f574131034d43e4d6 Mon Sep 17 00:00:00 2001 From: arcabot Date: Tue, 16 Jan 2024 15:05:02 +0000 Subject: [PATCH] Automatic upate of README.md by arcaflow-docsgen arcabot --- README.md | 91 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 80 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 14d90e6..ddbefac 100644 --- a/README.md +++ b/README.md @@ -55,10 +55,19 @@ Load data into opensearch compatible instance ### Input - - +
Type:scope
Root object:StoreDocumentRequest
Properties
data (map[string, +
Type:scope
Root object:DocumentRequest
Properties
bulk_upload_list (list[reference[BulkUploadObject]]) +
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
+
+ List items +
Type:reference[BulkUploadObject]
Referenced object:BulkUploadObject
+
+
+
default_index (string) +
Name:index
Description:Name of the default index that will receive the data.
Required:Yes
Type:string
Minimum length:1
+
metadata (map[string, any]) - -
Name:data
Description:Data to upload to your index
Required:Yes
Type:map[string, +
Name:metadata
Description:Optional global metadata object that will be added to every document.
Required:No
Type:map[string, any]
Key type @@ -73,8 +82,6 @@ Load data into opensearch compatible instance
-
index (string) -
Name:index
Description:Name of the index that will receive the data.
Required:Yes
Type:string
Minimum length:1
password (string)
Name:password
Description:The password for the given user.
Required:No
Type:string
tls_verify (bool) @@ -84,10 +91,60 @@ Load data into opensearch compatible instance
username (string)
Name:username
Description:A username for an authorized user for the given Opensearch-compatible instance.
Required:No
Type:string
Minimum length:1
Objects
StoreDocumentRequest (object) +
Objects
BulkUploadObject (object)
Type:object
Properties
data (map[string, any]) - +
Name:data
Description:Data to upload to your index
Required:Yes
Type:map[string, + + +
Name:data
Description:The JSON data document to upload to your index.
Required:Yes
Type:map[string, + any]
+
+ Key type +
Type:string
+
+
+
+ Value type +
Type: + any
+
+
+
operation (map[string, reference[BulkUploadOperationMeta]]) + + +
Name:operation
Description:The operation type and associated operation metadata.
Required:Yes
Type:map[string, reference[BulkUploadOperationMeta]]
+
+ Key type +
Type:string
+
+
+
+ Value type +
Type:reference[BulkUploadOperationMeta]
Referenced object:BulkUploadOperationMeta
+
+
+
+
BulkUploadOperationMeta (object) + +
Type:object
Properties
_id (string) +
Name:ID
Description:Optional ID for the data document.
Required:No
Type:string
+
_index (string) +
Name:index
Description:Optional name of the index that will receive the data. If none is provided, the default index will be used.
Required:No
Type:string
+
+
DocumentRequest (object) +
Type:object
Properties
bulk_upload_list (list[reference[BulkUploadObject]]) +
Name:bulk upload list
Description:The list of objects for the bulk upload operation.
Required:Yes
Type:list[reference[BulkUploadObject]]
+
+ List items +
Type:reference[BulkUploadObject]
Referenced object:BulkUploadObject
+
+
+
default_index (string) +
Name:index
Description:Name of the default index that will receive the data.
Required:Yes
Type:string
Minimum length:1
+
metadata (map[string, + any]) +
Name:metadata
Description:Optional global metadata object that will be added to every document.
Required:No
Type:map[string, any]
Key type @@ -102,8 +159,6 @@ Load data into opensearch compatible instance
-
index (string) -
Name:index
Description:Name of the index that will receive the data.
Required:Yes
Type:string
Minimum length:1
password (string)
Name:password
Description:The password for the given user.
Required:No
Type:string
tls_verify (bool) @@ -139,11 +194,25 @@ Load data into opensearch compatible instance -
Type:scope
Root object:SuccessOutput
Properties
message (string) +
Properties
document_ids (list[string]) +
Required:Yes
Type:list[string]
+
+ List items +
Type:string
+
+
+
message (string)
Required:Yes
Type:string
Objects
SuccessOutput (object) -
Type:object
Properties
message (string) +
Type:object
Properties
document_ids (list[string]) +
Required:Yes
Type:list[string]
+
+ List items +
Type:string
+
+
+
message (string)
Required:Yes
Type:string