Skip to content

Commit d52e77c

Browse files
committed
Document JSON ingestion gem dependencies
1 parent 8ea9e97 commit d52e77c

4 files changed

Lines changed: 16 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,10 @@ All gems follow the pattern: `elasticgraph-[name]/` containing:
8585
- `elasticgraph-elasticsearch`: Elasticsearch client wrapper
8686
- `elasticgraph-opensearch`: OpenSearch client wrapper
8787

88-
**Extensions** (5 gems): Optional functionality
88+
**Extensions** (6 gems): Optional functionality
8989
- `elasticgraph-apollo`: Apollo Federation support
9090
- `elasticgraph-health_check`: Health checks
91+
- `elasticgraph-json_ingestion`: JSON Schema ingestion serializer
9192
- `elasticgraph-query_interceptor`: Query interception
9293
- `elasticgraph-query_registry`: Source-controlled query registry
9394
- `elasticgraph-warehouse`: Data warehouse ingestion

CODEBASE_OVERVIEW.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ graph LR;
111111
rackup["rackup"];
112112
rake["rake"];
113113
webrick["webrick"];
114+
elasticgraph-json_ingestion["eg-json_ingestion"];
114115
elasticgraph-schema_artifacts["eg-schema_artifacts"];
115116
graphql["graphql"];
116117
elasticgraph --> elasticgraph-support;
@@ -125,6 +126,7 @@ graph LR;
125126
elasticgraph-local --> webrick;
126127
elasticgraph-schema_definition --> elasticgraph-graphql;
127128
elasticgraph-schema_definition --> elasticgraph-indexer;
129+
elasticgraph-schema_definition --> elasticgraph-json_ingestion;
128130
elasticgraph-schema_definition --> elasticgraph-schema_artifacts;
129131
elasticgraph-schema_definition --> elasticgraph-support;
130132
elasticgraph-schema_definition --> graphql;
@@ -141,6 +143,7 @@ graph LR;
141143
class rackup externalGemCatStyle;
142144
class rake externalGemCatStyle;
143145
class webrick externalGemCatStyle;
146+
class elasticgraph-json_ingestion otherEgGemStyle;
144147
class elasticgraph-schema_artifacts otherEgGemStyle;
145148
class graphql externalGemCatStyle;
146149
click thor href "https://rubygems.org/gems/thor" "Open on RubyGems.org" _blank;
@@ -192,12 +195,13 @@ graph LR;
192195
click opensearch-ruby href "https://rubygems.org/gems/opensearch-ruby" "Open on RubyGems.org" _blank;
193196
```
194197

195-
### Extensions (5 gems)
198+
### Extensions (6 gems)
196199

197200
These libraries extend ElasticGraph to provide optional but commonly needed functionality.
198201

199202
* [elasticgraph-apollo](elasticgraph-apollo/README.md): Transforms an ElasticGraph project into an Apollo subgraph.
200203
* [elasticgraph-health_check](elasticgraph-health_check/README.md): Provides a health check for high availability ElasticGraph deployments.
204+
* [elasticgraph-json_ingestion](elasticgraph-json_ingestion/README.md): JSON Schema ingestion support for ElasticGraph.
201205
* [elasticgraph-query_interceptor](elasticgraph-query_interceptor/README.md): Intercepts ElasticGraph datastore queries.
202206
* [elasticgraph-query_registry](elasticgraph-query_registry/README.md): Provides a source-controlled query registry for ElasticGraph applications.
203207
* [elasticgraph-warehouse](elasticgraph-warehouse/README.md): Extends ElasticGraph to support ingestion into a data warehouse.
@@ -216,6 +220,7 @@ graph LR;
216220
apollo-federation["apollo-federation"];
217221
elasticgraph-health_check["eg-health_check"];
218222
elasticgraph-datastore_core["eg-datastore_core"];
223+
elasticgraph-json_ingestion["eg-json_ingestion"];
219224
elasticgraph-query_interceptor["eg-query_interceptor"];
220225
elasticgraph-schema_artifacts["eg-schema_artifacts"];
221226
elasticgraph-query_registry["eg-query_registry"];
@@ -228,6 +233,7 @@ graph LR;
228233
elasticgraph-health_check --> elasticgraph-datastore_core;
229234
elasticgraph-health_check --> elasticgraph-graphql;
230235
elasticgraph-health_check --> elasticgraph-support;
236+
elasticgraph-json_ingestion --> elasticgraph-support;
231237
elasticgraph-query_interceptor --> elasticgraph-graphql;
232238
elasticgraph-query_interceptor --> elasticgraph-schema_artifacts;
233239
elasticgraph-query_registry --> elasticgraph-graphql;
@@ -242,6 +248,7 @@ graph LR;
242248
class apollo-federation externalGemCatStyle;
243249
class elasticgraph-health_check targetGemStyle;
244250
class elasticgraph-datastore_core otherEgGemStyle;
251+
class elasticgraph-json_ingestion targetGemStyle;
245252
class elasticgraph-query_interceptor targetGemStyle;
246253
class elasticgraph-schema_artifacts otherEgGemStyle;
247254
class elasticgraph-query_registry targetGemStyle;

elasticgraph-schema_definition/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ graph LR;
2121
elasticgraph-indexer["elasticgraph-indexer"];
2222
elasticgraph-schema_definition --> elasticgraph-indexer;
2323
class elasticgraph-indexer otherEgGemStyle;
24+
elasticgraph-json_ingestion["elasticgraph-json_ingestion"];
25+
elasticgraph-schema_definition --> elasticgraph-json_ingestion;
26+
class elasticgraph-json_ingestion otherEgGemStyle;
2427
elasticgraph-schema_artifacts["elasticgraph-schema_artifacts"];
2528
elasticgraph-schema_definition --> elasticgraph-schema_artifacts;
2629
class elasticgraph-schema_artifacts otherEgGemStyle;

elasticgraph-support/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ graph LR;
4545
elasticgraph-indexer["elasticgraph-indexer"];
4646
elasticgraph-indexer --> elasticgraph-support;
4747
class elasticgraph-indexer otherEgGemStyle;
48+
elasticgraph-json_ingestion["elasticgraph-json_ingestion"];
49+
elasticgraph-json_ingestion --> elasticgraph-support;
50+
class elasticgraph-json_ingestion otherEgGemStyle;
4851
elasticgraph-opensearch["elasticgraph-opensearch"];
4952
elasticgraph-opensearch --> elasticgraph-support;
5053
class elasticgraph-opensearch otherEgGemStyle;

0 commit comments

Comments
 (0)