Skip to content

Commit d4ab6ce

Browse files
github-actions[bot]github-actions[bot]
committed
Update schema for latest release
1 parent 03ed543 commit d4ab6ce

2 files changed

Lines changed: 21 additions & 65 deletions

File tree

‎schema/latest/pipelines-schema.json‎

Lines changed: 19 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/es-pipeline-doc-in",
2+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/es-pipeline-doc-in",
33
"$schema": "https://json-schema.org/draft/2020-12/schema",
44
"preservedOrder": [
55
"id",
@@ -344,14 +344,13 @@
344344
"recordFavorite",
345345
"recordSaveSearch",
346346
"searchboxPreferences",
347-
"boost",
348-
"marklogicQuery"
347+
"boost"
349348
],
350349
"stages": {
351350
"addFilter": {
352351
"description": "Add Filter action allows you to define the term filters that will get applied on the search type of queries. For example, if somebody searches for iphone then you may want to apply a brand filter with value as apple.",
353352
"inputs": {
354-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/add-filter-input",
353+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/add-filter-input",
355354
"$schema": "https://json-schema.org/draft/2020-12/schema",
356355
"properties": {
357356
"data": {
@@ -375,7 +374,7 @@
375374
"boost": {
376375
"description": "Boost stage is useful to boost search results by a specific field’s value, for example, show items with 'holiday-sale' and 'premium' values for 'tag' field above other items.",
377376
"inputs": {
378-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/boost-stage-input-struct",
377+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/boost-stage-input-struct",
379378
"$schema": "https://json-schema.org/draft/2020-12/schema",
380379
"properties": {
381380
"boostFactor": {
@@ -441,7 +440,7 @@
441440
"customData": {
442441
"description": "Helps in sending the custom JSON data in the search response. This will be helpful when you want to send some extra information to the frontend, which can help in rendering more specific information.",
443442
"inputs": {
444-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/custom-data-input",
443+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/custom-data-input",
445444
"$schema": "https://json-schema.org/draft/2020-12/schema",
446445
"properties": {
447446
"data": {
@@ -459,7 +458,7 @@
459458
"elasticsearchQuery": {
460459
"description": "To perform a request to Elasticsearch Backend.\n\nElasticsearch stage supports async execution. In case of asynchronous execution, you're expected to write a merge script to consume the response from elasticsearch.\nThe elasticsearch response would be present in global script context with stage Id (defaults to elasticsearchQuery) as key.",
461460
"inputs": {
462-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/elasticsearch-query-input",
461+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/elasticsearch-query-input",
463462
"$schema": "https://json-schema.org/draft/2020-12/schema",
464463
"properties": {
465464
"body": {
@@ -520,7 +519,7 @@
520519
"hideResults": {
521520
"description": "It helps in hiding certain results from getting included in the actual search results. For example, you want to hide products that not available in the store, or you want to hide results that contain irrelevant data.",
522521
"inputs": {
523-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/hide-result-input",
522+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/hide-result-input",
524523
"$schema": "https://json-schema.org/draft/2020-12/schema",
525524
"properties": {
526525
"data": {
@@ -542,7 +541,7 @@
542541
"httpRequest": {
543542
"description": "This stage is useful to perform HTTP requests.",
544543
"inputs": {
545-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/http-request-input",
544+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/http-request-input",
546545
"$schema": "https://json-schema.org/draft/2020-12/schema",
547546
"properties": {
548547
"body": {
@@ -591,7 +590,7 @@
591590
"kNN": {
592591
"description": "k Nearest Neighbor (kNN) modifies the ElasticSearch Query with a script_score condition to re-rank the top n results.",
593592
"inputs": {
594-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/knn-struct",
593+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/knn-struct",
595594
"$schema": "https://json-schema.org/draft/2020-12/schema",
596595
"properties": {
597596
"backend": {
@@ -601,8 +600,7 @@
601600
"opensearch",
602601
"mongodb",
603602
"solr",
604-
"zinc",
605-
"marklogic"
603+
"zinc"
606604
],
607605
"title": "Search Backend",
608606
"type": "string"
@@ -1491,51 +1489,10 @@
14911489
},
14921490
"title": "kNN Response"
14931491
},
1494-
"marklogicQuery": {
1495-
"description": "To perform a request to MarkLogic.",
1496-
"inputs": {
1497-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/mark-logic-input",
1498-
"$schema": "https://json-schema.org/draft/2020-12/schema",
1499-
"properties": {
1500-
"headers": {
1501-
"description": "Headers to be passed in the Solr query request.",
1502-
"patternProperties": {
1503-
".*": {
1504-
"type": "string"
1505-
}
1506-
},
1507-
"title": "Headers",
1508-
"type": "object"
1509-
},
1510-
"password": {
1511-
"description": "Password to access the URI passed",
1512-
"title": "Password",
1513-
"type": "string"
1514-
},
1515-
"type": {
1516-
"description": "Type of request to make to MarkLogic. Valid options are sparql, search or optic",
1517-
"title": "Type",
1518-
"type": "string"
1519-
},
1520-
"uri": {
1521-
"description": "URI to connect to the fusion instance. If passed, host, app, profile and credentials will be ignored and not required. Example: 'http://username:password@localhost:6764/api/apps/appbase/query/appbase'",
1522-
"title": "URI",
1523-
"type": "string"
1524-
},
1525-
"username": {
1526-
"description": "Username to access the URI passed",
1527-
"title": "Username",
1528-
"type": "string"
1529-
}
1530-
},
1531-
"type": "object"
1532-
},
1533-
"title": "MarkLogic"
1534-
},
15351492
"mongoDBQuery": {
15361493
"description": "To perform a request to MongoDB.\n\nMongoDB stage supports async execution. In case of asynchronous execution, you're expected to write a merge script to consume the response from mongoDB.\nThe mongoDB response would be present in global script context with stage Id (defaults to mongoDBQuery) as key.",
15371494
"inputs": {
1538-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/mongo-db-input",
1495+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/mongo-db-input",
15391496
"$schema": "https://json-schema.org/draft/2020-12/schema",
15401497
"properties": {
15411498
"body": {
@@ -1590,7 +1547,7 @@
15901547
"promoteResults": {
15911548
"description": "Helps in promoting results at a certain position in your result set. For example, when a user searches for iphone you want to promote air pods.",
15921549
"inputs": {
1593-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/promoted-result-input",
1550+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/promoted-result-input",
15941551
"$schema": "https://json-schema.org/draft/2020-12/schema",
15951552
"properties": {
15961553
"data": {
@@ -1650,7 +1607,7 @@
16501607
"removeWords": {
16511608
"description": "Removing words is the progressive loosening of query constraints to include more results when none are initially found.\n\nFor example, imagine an online smartphone shop that sold a limited inventory of iPhones in only 16GB and 32GB varieties. Users searching for “iphone 5 64gb” would see no results. This is not ideal behavior - it would be far better to show users some iPhone 5 results instead of a blank page.",
16521609
"inputs": {
1653-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/remove-words-input",
1610+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/remove-words-input",
16541611
"$schema": "https://json-schema.org/draft/2020-12/schema",
16551612
"properties": {
16561613
"data": {
@@ -1672,7 +1629,7 @@
16721629
"replaceSearchTerm": {
16731630
"description": "It helps in replacing the user's entire search query with another query. Helps in showing relevant results to users, especially when you are aware of the analytics that certain search term is returning no results.",
16741631
"inputs": {
1675-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/replace-search-input",
1632+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/replace-search-input",
16761633
"$schema": "https://json-schema.org/draft/2020-12/schema",
16771634
"properties": {
16781635
"data": {
@@ -1691,7 +1648,7 @@
16911648
"replaceWords": {
16921649
"description": "It allows you to replace words in search query. For example, if you make tv a synonym for television, the stage can replace tv with television so that only television is used to search.",
16931650
"inputs": {
1694-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/replace-words-input",
1651+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/replace-words-input",
16951652
"$schema": "https://json-schema.org/draft/2020-12/schema",
16961653
"properties": {
16971654
"data": {
@@ -1715,7 +1672,7 @@
17151672
"searchRelevancy": {
17161673
"description": "Search Relevancy stage is useful to define the default settings for search queries. For example, to set the default size as 10 for search queries.",
17171674
"inputs": {
1718-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/search-relevancy-struct",
1675+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/search-relevancy-struct",
17191676
"$schema": "https://json-schema.org/draft/2020-12/schema",
17201677
"properties": {
17211678
"geo": {
@@ -6131,7 +6088,7 @@
61316088
"searchboxPreferences": {
61326089
"description": "Searchbox Preferences stage is useful to specify the searchbox preference id for making suggestion queries. A searchbox id represents the design + layout, popular, recent, and endpoint settings for a suggestions experience, configurable from the ReactiveSearch dashboard",
61336090
"inputs": {
6134-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/searchbox-preferences-struct",
6091+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/searchbox-preferences-struct",
61356092
"$schema": "https://json-schema.org/draft/2020-12/schema",
61366093
"properties": {
61376094
"id": {
@@ -6147,7 +6104,7 @@
61476104
"solrQuery": {
61486105
"description": "To perform a request to a Solr search engine",
61496106
"inputs": {
6150-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/solr-input",
6107+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/solr-input",
61516108
"$schema": "https://json-schema.org/draft/2020-12/schema",
61526109
"properties": {
61536110
"app": {
@@ -6228,7 +6185,7 @@
62286185
"zincQuery": {
62296186
"description": "To perform a request to Zinc",
62306187
"inputs": {
6231-
"$id": "https://github.com/appbaseio-confidential/arc-noss/plugins/pipelines/zinc-input",
6188+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/pipelines/zinc-input",
62326189
"$schema": "https://json-schema.org/draft/2020-12/schema",
62336190
"properties": {
62346191
"credentials": {

‎schema/latest/schema.json‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$id": "https://github.com/appbaseio/reactivesearch-api/plugins/querytranslate/rs-query",
2+
"$id": "https://github.com/appbaseio-confidential/reactivesearch/plugins/querytranslate/rs-query",
33
"$schema": "https://json-schema.org/draft/2020-12/schema",
44
"additionalProperties": false,
55
"preservedOrder": [
@@ -1272,8 +1272,7 @@
12721272
"opensearch",
12731273
"mongodb",
12741274
"solr",
1275-
"zinc",
1276-
"marklogic"
1275+
"zinc"
12771276
],
12781277
"markdownDescription": "This field indicates the backend of ReactiveSearch. Backend implies the search service being used to store the data.\n\nAs of now, the `backend` field supports the following values:\n\n1. `elasticsearch`: ElasticSearch\n2. `opensearch`: OpenSearch\n\nwhere `elasticsearch` is the default value.\n\n\u003e This field is necessary if backend is OpenSearch and the kNN reordering of scripts are to be used.\n\nFollowing example indicates how to use this field to use kNN reordering with OpenSearch as backend:\n\n```json\n{\n \"query\": [\n {\n \"value\": \"sudoku\",\n \"vectorDataField\": \"name_vector\",\n \"queryVector\": [1.0, -0.2],\n }\n ],\n \"settings\": {\n \"backend\": \"opensearch\"\n }\n}\n```",
12791278
"title": "backend",

0 commit comments

Comments
 (0)