Skip to content

Commit d113966

Browse files
lcawlgithub-actions[bot]
lcawl
authored and
github-actions[bot]
committed
Add connector API examples (#3428)
(cherry picked from commit ec9e440)
1 parent 9724f7f commit d113966

File tree

35 files changed

+238
-0
lines changed

35 files changed

+238
-0
lines changed

‎specification/connector/check_in/ConnectorCheckInResponseExample1.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/check-in-connector-api.asciidoc:73
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value: "{\n \"result\": \"updated\"\n}"

‎specification/connector/delete/ConnectorDeleteResponseExample1.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/delete-connector-api.asciidoc:74
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value: "{\n \"acknowledged\": true\n}"

‎specification/connector/last_sync/ConnectorUpdateLastSyncRequestExample1.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# summary: connector/apis/update-connector-last-sync-api.asciidoc:115
2+
# method_request: PUT _connector/my-connector/_last_sync
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"last_access_control_sync_error\": \"Houston, we have a problem!\"\
7+
,\n \"last_access_control_sync_scheduled_at\": \"2023-11-09T15:13:08.231Z\",\n\
8+
\ \"last_access_control_sync_status\": \"pending\",\n \"last_deleted_document_count\"\
9+
: 42,\n \"last_incremental_sync_scheduled_at\": \"2023-11-09T15:13:08.231Z\"\
10+
,\n \"last_indexed_document_count\": 42,\n \"last_sync_error\": \"Houston,\
11+
\ we have a problem!\",\n \"last_sync_scheduled_at\": \"2024-11-09T15:13:08.231Z\"\
12+
,\n \"last_sync_status\": \"completed\",\n \"last_synced\": \"2024-11-09T15:13:08.231Z\"\
13+
\n}"

‎specification/connector/put/ConnectorPutRequestExample1.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# summary: connector/apis/create-connector-api.asciidoc:20
2+
# method_request: PUT _connector/my-connector
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"index_name\": \"search-google-drive\",\n \"name\": \"My Connector\"\
7+
,\n \"service_type\": \"google_drive\"\n}"

‎specification/connector/put/ConnectorPutRequestExample2.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# summary: connector/apis/create-connector-api.asciidoc:111
2+
# method_request: PUT _connector/my-connector
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"index_name\": \"search-google-drive\",\n \"name\": \"My Connector\"\
7+
,\n \"description\": \"My Connector to sync data to Elastic index from Google Drive\"\
8+
,\n \"service_type\": \"google_drive\",\n \"language\": \"english\"\n}"

‎specification/connector/put/ConnectorPutResponseExample1.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# summary: connector/apis/create-connector-api.asciidoc:126
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value:
6+
result: created
7+
id: my-connector

‎specification/connector/sync_job_delete/SyncJobDeleteResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/delete-connector-sync-job-api.asciidoc:51
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value:
6+
acknowledged: true

‎specification/connector/sync_job_error/SyncJobErrorRequestExample1.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/set-connector-sync-job-error-api.asciidoc:56
2+
# method_request: PUT _connector/_sync_job/my-connector-sync-job/_error
3+
# description: ''
4+
# type: request
5+
value: "{\n \"error\": \"some-error\"\n}"

‎specification/connector/sync_job_post/SyncJobPostRequestExample1.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# summary: connector/apis/create-connector-sync-job-api.asciidoc:15
2+
# method_request: POST _connector/_sync_job
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"id\": \"connector-id\",\n \"job_type\": \"full\",\n \"trigger_method\"\
7+
: \"on_demand\"\n}"

‎specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-api-key-id-api.asciidoc:95
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value:
6+
result: updated

‎specification/connector/update_api_key_id/ConnectorUpdateApiKeyIdExample1.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# summary: connector/apis/update-connector-api-key-id-api.asciidoc:86
2+
# method_request: PUT _connector/my-connector/_api_key_id
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"api_key_id\": \"my-api-key-id\",\n \"api_key_secret_id\": \"my-connector-secret-id\"\
7+
\n}"

‎specification/connector/update_configuration/ConnectorUpdateConfigurationRequestExample1.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# summary: connector/apis/update-connector-configuration-api.asciidoc:308
2+
# method_request: PUT _connector/my-spo-connector/_configuration
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"values\": {\n \"tenant_id\": \"my-tenant-id\",\n \"\
7+
tenant_name\": \"my-sharepoint-site\",\n \"client_id\": \"foo\",\n \
8+
\ \"secret_value\": \"bar\",\n \"site_collections\": \"*\"\n }\n}"

‎specification/connector/update_configuration/ConnectorUpdateConfigurationRequestExample2.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/update-connector-configuration-api.asciidoc:335
2+
# method_request: PUT _connector/my-spo-connector/_configuration
3+
# description: ''
4+
# type: request
5+
value: "{\n \"values\": {\n \"secret_value\": \"foo-bar\"\n }\n}"

‎specification/connector/update_configuration/ConnectorUpdateConfigurationResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-configuration-api.asciidoc:322
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value:
6+
result: updated

‎specification/connector/update_error/ConnectorUpdateErrorRequestExample1.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/update-connector-error-api.asciidoc:75
2+
# method_request: PUT _connector/my-connector/_error
3+
# description: ''
4+
# type: request
5+
value: "{\n \"error\": \"Houston, we have a problem!\"\n}"

‎specification/connector/update_error/ConnectorUpdateErrorResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-error-api.asciidoc:83
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value:
6+
result: updated

‎specification/connector/update_features/ConnectorUpdateFeaturesRequestExample1.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# summary: connector/apis/update-connector-features-api.asciidoc:90
2+
# method_request: PUT _connector/my-connector/_features
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"features\": {\n \"document_level_security\": {\n \"enabled\"\
7+
: true\n },\n \"incremental_sync\": {\n \"enabled\": true\n },\n \
8+
\ \"sync_rules\": {\n \"advanced\": {\n \"enabled\": false\n \
9+
\ },\n \"basic\": {\n \"enabled\": true\n }\n }\n }\n}"

‎specification/connector/update_features/ConnectorUpdateFeaturesRequestExample2.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# summary: connector/apis/update-connector-features-api.asciidoc:122
2+
# method_request: PUT _connector/my-connector/_features
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"features\": {\n \"document_level_security\": {\n \"enabled\"\
7+
: true\n }\n }\n}"

‎specification/connector/update_features/ConnectorUpdateFeaturesResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-features-api.asciidoc:113
2+
# description: ''
3+
# type: response
4+
# response_code: ''
5+
value:
6+
result: updated

‎specification/connector/update_filtering/ConnectorUpdateFilteringRequestExample1.yaml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# summary: connector/apis/update-connector-filtering-api.asciidoc:115
2+
# method_request: PUT _connector/my-g-drive-connector/_filtering
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"rules\": [\n {\n \"field\": \"file_extension\"\
7+
,\n \"id\": \"exclude-txt-files\",\n \"order\": 0,\n \
8+
\ \"policy\": \"exclude\",\n \"rule\": \"equals\",\n \
9+
\ \"value\": \"txt\"\n },\n {\n \"field\": \"_\",\n \
10+
\ \"id\": \"DEFAULT\",\n \"order\": 1,\n \"policy\"\
11+
: \"include\",\n \"rule\": \"regex\",\n \"value\": \".*\"\n\
12+
\ }\n ]\n}"

‎specification/connector/update_filtering/ConnectorUpdateFilteringRequestExample2.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# summary: connector/apis/update-connector-filtering-api.asciidoc:149
2+
# method_request: PUT _connector/my-sql-connector/_filtering
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"advanced_snippet\": {\n \"value\": [{\n \"tables\"\
7+
: [\n \"users\",\n \"orders\"\n ],\n \
8+
\ \"query\": \"SELECT users.id AS id, orders.order_id AS order_id FROM\
9+
\ users JOIN orders ON users.id = orders.user_id\"\n }]\n }\n}"

‎specification/connector/update_filtering/ConnectorUpdateFilteringResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-filtering-api.asciidoc:140
2+
# description: ''
3+
# type: response
4+
# response_code: 200
5+
value:
6+
result: updated

‎specification/connector/update_index_name/ConnectorUpdateIndexNameRequestExample1.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/update-connector-index-name-api.asciidoc:75
2+
# method_request: PUT _connector/my-connector/_index_name
3+
# description: ''
4+
# type: request
5+
value: "{\n \"index_name\": \"data-from-my-google-drive\"\n}"

‎specification/connector/update_index_name/ConnectorUpdateIndexNameResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-index-name-api.asciidoc:83
2+
# description: ''
3+
# type: response
4+
# response_code: 200
5+
value:
6+
result: updated

‎specification/connector/update_name/ConnectorUpdateNameRequestExample1.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# summary: connector/apis/update-connector-name-description-api.asciidoc:79
2+
# method_request: PUT _connector/my-connector/_name
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"name\": \"Custom connector\",\n \"description\": \"This is my\
7+
\ customized connector\"\n}"

‎specification/connector/update_name/ConnectorUpdateNameResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-name-description-api.asciidoc:88
2+
# description: ''
3+
# type: response
4+
# response_code: 200
5+
value:
6+
result: updated

‎specification/connector/update_pipeline/ConnectorUpdatePipelineRequestExample1.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# summary: connector/apis/update-connector-pipeline-api.asciidoc:87
2+
# method_request: PUT _connector/my-connector/_pipeline
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"pipeline\": {\n \"extract_binary_content\": true,\n \
7+
\ \"name\": \"my-connector-pipeline\",\n \"reduce_whitespace\": true,\n\
8+
\ \"run_ml_inference\": true\n }\n}"

‎specification/connector/update_pipeline/ConnectorUpdatePipelineResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-pipeline-api.asciidoc:100
2+
# description: ''
3+
# type: response
4+
# response_code: 200
5+
value:
6+
result: updated

‎specification/connector/update_scheduling/ConnectorUpdateSchedulingRequestExample1.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# summary: connector/apis/update-connector-scheduling-api.asciidoc:89
2+
# method_request: PUT _connector/my-connector/_scheduling
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"scheduling\": {\n \"access_control\": {\n \"enabled\"\
7+
: true,\n \"interval\": \"0 10 0 * * ?\"\n },\n \"full\"\
8+
: {\n \"enabled\": true,\n \"interval\": \"0 20 0 * * ?\"\n\
9+
\ },\n \"incremental\": {\n \"enabled\": false,\n \
10+
\ \"interval\": \"0 30 0 * * ?\"\n }\n }\n}"

‎specification/connector/update_scheduling/ConnectorUpdateSchedulingRequestExample2.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# summary: connector/apis/update-connector-scheduling-api.asciidoc:119
2+
# method_request: PUT _connector/my-connector/_scheduling
3+
# description: ''
4+
# type: request
5+
value:
6+
"{\n \"scheduling\": {\n \"full\": {\n \"enabled\": true,\n\
7+
\ \"interval\": \"0 10 0 * * ?\"\n }\n }\n}"

‎specification/connector/update_scheduling/ConnectorUpdateSchedulingResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-scheduling-api.asciidoc:110
2+
# description: ''
3+
# type: response
4+
# response_code: 200
5+
value:
6+
result: updated

‎specification/connector/update_service_type/ConnectorUpdateServiceTypeRequestExample1.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/update-connector-service-type-api.asciidoc:77
2+
# method_request: PUT _connector/my-connector/_service_type
3+
# description: ''
4+
# type: request
5+
value: "{\n \"service_type\": \"sharepoint_online\"\n}"

‎specification/connector/update_service_type/ConnectorUpdateServiceTypeResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-service-type-api.asciidoc:85
2+
# description: ''
3+
# type: response
4+
# response_code: 200
5+
value:
6+
result: updated

‎specification/connector/update_status/ConnectorUpdateStatusRequestExample1.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# summary: connector/apis/update-connector-status-api.asciidoc:75
2+
# method_request: PUT _connector/my-connector/_status
3+
# description: ''
4+
# type: request
5+
value: "{\n \"status\": \"needs_configuration\"\n}"

‎specification/connector/update_status/ConnectorUpdateStatusResponseExample1.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# summary: connector/apis/update-connector-status-api.asciidoc:83
2+
# description: ''
3+
# type: response
4+
# response_code: 200
5+
value:
6+
result: updated

0 commit comments

Comments
 (0)