{ "uuid": "bb2e079d-1fd8-4f3f-93f7-ceca9c9fabed", "lastMigration": 29, "name": "SearchIndexClient", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "fd7daf45-b743-4334-9551-120553a0bc96", "documentation": "Searches for documents in the index.", "method": "get", "endpoint": "docs", "responses": [ { "uuid": "50d8f58d-9c9f-470e-82ac-f5261c94c22d", "body": "{\n \"@odata.count\": {{faker 'number.int' max=99999}},\n \"@odata.nextLink\": \"\",\n \"@search.coverage\": {{faker 'number.float'}},\n \"@search.facets\": {},\n \"@search.nextPageParameters\": {\n \"count\": {{faker 'datatype.boolean'}},\n \"facets\": [\n \"\"\n ],\n \"filter\": \"\",\n \"highlight\": \"\",\n \"highlightPostTag\": \"\",\n \"highlightPreTag\": \"\",\n \"minimumCoverage\": {{faker 'number.float'}},\n \"orderby\": \"\",\n \"queryType\": \"{{oneOf (array 'simple' 'full')}}\",\n \"scoringParameters\": [\n \"\"\n ],\n \"scoringProfile\": \"\",\n \"search\": \"\",\n \"searchFields\": \"\",\n \"searchMode\": \"{{oneOf (array 'any' 'all')}}\",\n \"select\": \"\",\n \"skip\": {{faker 'number.int' max=99999}},\n \"top\": {{faker 'number.int' max=99999}}\n },\n \"value\": [\n {\n \"@search.highlights\": {},\n \"@search.score\": {{faker 'number.float'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Response containing documents that match the search criteria.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80b71529-9cb2-4eb3-a3e0-8dc3cfd80d45", "documentation": "Retrieves a document from the index.", "method": "get", "endpoint": "docs(':key')", "responses": [ { "uuid": "fed276a0-b743-4735-8f8e-b06b9e38567d", "body": "{}", "latency": 0, "statusCode": 200, "label": "Response containing the requested document.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4ca2a90-e41c-4c21-977e-a38c2f89c363", "documentation": "Queries the number of documents in the index.", "method": "get", "endpoint": "docs/$count", "responses": [ { "uuid": "c724f4a8-fa15-43df-8532-522c281cd386", "body": "{{faker 'number.int' max=99999}}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c2f07a9-ff84-4248-b49a-532812f26418", "documentation": "Autocompletes incomplete query terms based on input text and matching terms in the index.", "method": "get", "endpoint": "docs/search.autocomplete", "responses": [ { "uuid": "c0d81050-9fe9-4beb-9e80-1e835e0fefac", "body": "{\n \"value\": [\n {\n \"queryPlusText\": \"\",\n \"text\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d125c54-5bcf-43b6-b367-d065fa073c81", "documentation": "Sends a batch of document write actions to the index.", "method": "post", "endpoint": "docs/search.index", "responses": [ { "uuid": "1469108a-9bf5-4594-94ca-c7e8a2d2c392", "body": "{\n \"value\": [\n {\n \"errorMessage\": \"\",\n \"key\": \"\",\n \"status\": {{faker 'datatype.boolean'}},\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Response containing the status of operations for all actions in the batch.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "899cbe95-b61e-4ee4-9925-b25e7afb5a42", "body": "{\n \"value\": [\n {\n \"errorMessage\": \"\",\n \"key\": \"\",\n \"status\": {{faker 'datatype.boolean'}},\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 207, "label": "Response containing the status of operations for all actions in the batch.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "96154e4a-7f5f-43b3-b5dd-49cc6ef0c662", "documentation": "Autocompletes incomplete query terms based on input text and matching terms in the index.", "method": "post", "endpoint": "docs/search.post.autocomplete", "responses": [ { "uuid": "4779e6ed-c25e-4b17-85c2-a89448ac7d04", "body": "{\n \"value\": [\n {\n \"queryPlusText\": \"\",\n \"text\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed8960cd-65bc-44b9-957f-28e4f2dfcd29", "documentation": "Searches for documents in the index.", "method": "post", "endpoint": "docs/search.post.search", "responses": [ { "uuid": "ab350fe2-7d59-45b1-be09-e1a0d94927f7", "body": "{\n \"@odata.count\": {{faker 'number.int' max=99999}},\n \"@odata.nextLink\": \"\",\n \"@search.coverage\": {{faker 'number.float'}},\n \"@search.facets\": {},\n \"@search.nextPageParameters\": {\n \"count\": {{faker 'datatype.boolean'}},\n \"facets\": [\n \"\"\n ],\n \"filter\": \"\",\n \"highlight\": \"\",\n \"highlightPostTag\": \"\",\n \"highlightPreTag\": \"\",\n \"minimumCoverage\": {{faker 'number.float'}},\n \"orderby\": \"\",\n \"queryType\": \"{{oneOf (array 'simple' 'full')}}\",\n \"scoringParameters\": [\n \"\"\n ],\n \"scoringProfile\": \"\",\n \"search\": \"\",\n \"searchFields\": \"\",\n \"searchMode\": \"{{oneOf (array 'any' 'all')}}\",\n \"select\": \"\",\n \"skip\": {{faker 'number.int' max=99999}},\n \"top\": {{faker 'number.int' max=99999}}\n },\n \"value\": [\n {\n \"@search.highlights\": {},\n \"@search.score\": {{faker 'number.float'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Response containing documents that match the search criteria.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a7b73910-3998-420b-9293-aa77de7dc62a", "documentation": "Suggests documents in the index that match the given partial query text.", "method": "post", "endpoint": "docs/search.post.suggest", "responses": [ { "uuid": "961329a3-8920-4e4a-b439-940d679e7011", "body": "{\n \"@search.coverage\": {{faker 'number.float'}},\n \"value\": [\n {\n \"@search.text\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Response containing suggested documents that match the partial input.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "427b1fb9-efe2-4284-9a70-515f38bde25d", "documentation": "Suggests documents in the index that match the given partial query text.", "method": "get", "endpoint": "docs/search.suggest", "responses": [ { "uuid": "14edbf22-95ab-4ba5-bea6-75cb76f616dc", "body": "{\n \"@search.coverage\": {{faker 'number.float'}},\n \"value\": [\n {\n \"@search.text\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Response containing suggested documents that match the partial input.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "fd7daf45-b743-4334-9551-120553a0bc96" }, { "type": "route", "uuid": "80b71529-9cb2-4eb3-a3e0-8dc3cfd80d45" }, { "type": "route", "uuid": "b4ca2a90-e41c-4c21-977e-a38c2f89c363" }, { "type": "route", "uuid": "3c2f07a9-ff84-4248-b49a-532812f26418" }, { "type": "route", "uuid": "1d125c54-5bcf-43b6-b367-d065fa073c81" }, { "type": "route", "uuid": "96154e4a-7f5f-43b3-b5dd-49cc6ef0c662" }, { "type": "route", "uuid": "ed8960cd-65bc-44b9-957f-28e4f2dfcd29" }, { "type": "route", "uuid": "a7b73910-3998-420b-9293-aa77de7dc62a" }, { "type": "route", "uuid": "427b1fb9-efe2-4284-9a70-515f38bde25d" } ] }