elasticgraph-query_registry 1.0.0.rc3 → 1.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e55d3669f857f23c53c42b5ce0508a6f7e04f231178e64bd86484443b142bdf9
-  data.tar.gz: 6160248c66703d8ba8a22f6b6378a29d1d2d837157521a5736fcc2bf5d152e0a
+  metadata.gz: 4bb6760dd59181027abbc286901e5a03c825378cde3867eef0fb02a3bbff9ce9
+  data.tar.gz: 8a8c7f3193a40f40bdfe9bdf8ffb32fb8db2dd2ed4cca6e4c2a79e5f22f56ebd
 SHA512:
-  metadata.gz: b2c0566bdaf378d474f31021724ca29260e872ac3c51698b45d3433f4bc108ede5ab7d2074e452ab9e0dc010341da649cb6c15585df25c1519fcb574a73e492d
-  data.tar.gz: b98482d9c7806fe572103385641deac2d5ac01ecbe9beba4b70bcf2c675ec8658da3b2f36b705c2a78adc3fcfe45641842f6433a6a3c7c7245dba3ee34a0afcf
+  metadata.gz: 8a971b45cea1fa5afe0da7242b2f9445c2a0348fa79601040a6839ec4d52ca936bdc394f0a1f29ddc9bb5ae7cd4a3c3cfa6d510cce8cac1f0963ea3614d32c89
+  data.tar.gz: 29187cf7027a40e3086e84846d86797a73b32d69245ae4e819f68ded25ce5fa941faf831a3d8949afba34acbeb3355831bf5684067a42e4211441b29889f24be

data/README.md

@@ -1,9 +1,9 @@
 # ElasticGraph::QueryRegistry
 
-`ElasticGraph::QueryRegistry` provides a simple source-controlled query
-registry for ElasticGraph applications. This is designed for cases where
-the clients of your application are other internal teams in your organization,
-who are willing to register their queries before using them.
+Provides a source-controlled query registry for ElasticGraph applications.
+This is designed for cases where the clients of your application are other
+internal teams in your organization, who are willing to register their
+queries before using them.
 
 Query registration provides a few key benefits:
 
@@ -104,19 +104,11 @@ execute any query.
 
 ## Setup
 
-First, add `elasticgraph-query_registry` to your `Gemfile`:
+`elasticgraph-query_registry` comes installed in new projects bootstrapped using `elasticgraph new`.
 
-``` ruby
-gem "elasticgraph-query_registry"
-```
-
-Next, configure this library in your ElasticGraph config YAML files:
+Configure it in your ElasticGraph config YAML files:
 
-``` yaml
-graphql:
-  extension_modules:
-  - require_path: elastic_graph/query_registry/graphql_extension
-    name: ElasticGraph::QueryRegistry::GraphQLExtension
+```yaml
 query_registry:
   allow_unregistered_clients: false
   allow_any_query_for_clients:
@@ -124,21 +116,6 @@ query_registry:
   path_to_registry: config/queries
 ```
 
-Next, load the `ElasticGraph::QueryRegistry` rake tasks in your `Rakefile`:
-
-``` ruby
-require "elastic_graph/query_registry/rake_tasks"
-
-ElasticGraph::QueryRegistry::RakeTasks.from_yaml_file(
-  "path/to/settings.yaml",
-  "config/queries",
-  require_eg_latency_slo_directive: true
-)
-```
-
-You'll want to add `rake query_registry:validate_queries` to your CI build so
-that every registered query is validated as part of every build.
-
 Finally, your application needs to include a `client:` when submitting
 each GraphQL query for execution. The client `name` should match the
 name of one of the registry client subdirectories. If you are using
@@ -159,10 +136,12 @@ This library also uses some generated artifacts (`*.variables.yaml` files)
 so it can detect when a change to the structure or type of a variable is
 backward-incompatible. For this to work, it requires that the generated
 variables files are kept up-to-date. Any time a change impacts the structure
-of any variables used by any queries, you'll need to run a task like
-`query_registry:dump_variables[client_name, query_name]` (or
-`query_registry:dump_variables:all`) to update the artifacts.
+of any variables used by any queries, you'll need to run a task to update the
+artifacts:
+
+```bash
+bundle exec rake "query_registry:dump_variables[client_name, query_name]"
+```
 
-Don't worry about if you forget this, though--the
-`query_registry:validate_queries` task will also fail and give you
-instructions anytime a variables file is not up-to-date.
+Don't worry about if you forget this, though--the `query_registry:validate_queries`
+task will also fail and give you instructions anytime a variables file is not up-to-date.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticgraph-query_registry
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
 platform: ruby
 authors:
 - Myron Marston
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
 - !ruby/object:Gem::Dependency
   name: elasticgraph-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -93,28 +93,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
 - !ruby/object:Gem::Dependency
   name: elasticgraph-opensearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: 1.0.0.rc4
 email:
 - myron@squareup.com
 executables: []
@@ -137,10 +137,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/block/elasticgraph/issues
-  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc3
-  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc3/
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc4
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc4/
   homepage_uri: https://block.github.io/elasticgraph/
-  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc3/elasticgraph-query_registry
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc4/elasticgraph-query_registry
   gem_category: extension
 rdoc_options: []
 require_paths:
@@ -159,9 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
-summary: An ElasticGraph extension that supports safer schema evolution by limiting
-  GraphQL queries based on a registry and validating registered queries against the
-  schema.
+summary: Provides a source-controlled query registry for ElasticGraph applications.
 test_files: []