Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Config doc #4604

Merged
merged 8 commits into from
Sep 29, 2022
Merged

Config doc #4604

merged 8 commits into from
Sep 29, 2022

Conversation

gilgardosh
Copy link
Collaborator

Create Mesh config dedicated document

@gilgardosh gilgardosh requested a review from ardatan September 29, 2022 12:06
@changeset-bot
Copy link

changeset-bot bot commented Sep 29, 2022

🦋 Changeset detected

Latest commit: b3ed23a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 94 packages
Name Type
@graphql-mesh/graphql Patch
@graphql-mesh/merger-federation Patch
@graphql-mesh/merger-stitching Patch
@graphql-mesh/mysql Patch
@graphql-mesh/odata Patch
@graphql-mesh/postgraphile Patch
@graphql-mesh/runtime Patch
@graphql-mesh/transform-encapsulate Patch
@graphql-mesh/transform-federation Patch
@graphql-mesh/transform-filter-schema Patch
@graphql-mesh/transform-hoist-field Patch
@graphql-mesh/transform-naming-convention Patch
@graphql-mesh/transform-prefix Patch
@graphql-mesh/transform-rename Patch
@graphql-mesh/transform-type-merging Patch
@graphql-mesh/types Patch
@graphql-mesh/utils Patch
@graphql-mesh/container Patch
graphql-file-upload-example Patch
covid-mesh Patch
postgres-geodb-example Patch
spacex-cfw Patch
type-merging-batching-example Patch
federation-gateway Patch
@graphql-mesh/config Patch
@graphql-mesh/merger-bare Patch
mysql-employees Patch
mysql-rfam Patch
odata-microsoft-graph-example Patch
odata-msgraph-programmatic-ts Patch
odata-msgraph-programmatic Patch
odata-trippin-example Patch
@graphql-mesh/cli Patch
@graphql-mesh/http Patch
nextjs-apollo-example Patch
nextjs-sdk-example Patch
typescript-location-weather-example Patch
grpc-example Patch
grpc-reflection-example Patch
@graphql-mesh/jit-executor Patch
json-machete Patch
@graphql-mesh/store Patch
@graphql-mesh/cache-cfw-kv Patch
@graphql-mesh/cache-file Patch
@graphql-mesh/cache-localforage Patch
@graphql-mesh/cache-redis Patch
@graphql-mesh/grpc Patch
@graphql-mesh/json-schema Patch
@graphql-mesh/mongoose Patch
@graphql-mesh/neo4j Patch
@graphql-mesh/openapi Patch
@graphql-mesh/raml Patch
@graphql-mesh/soap Patch
@graphql-mesh/thrift Patch
@graphql-mesh/tuql Patch
@graphql-mesh/transform-cache Patch
@graphql-mesh/transform-extend Patch
@graphql-mesh/transform-prune Patch
@graphql-mesh/transform-rate-limit Patch
@graphql-mesh/transform-replace-field Patch
@graphql-mesh/transform-resolvers-composition Patch
@graphql-mesh/transform-snapshot Patch
@graphql-mesh/plugin-live-query Patch
@graphql-mesh/plugin-mock Patch
@graphql-mesh/plugin-newrelic Patch
@graphql-mesh/plugin-operation-field-permissions Patch
@graphql-mesh/plugin-prometheus Patch
@graphql-mesh/plugin-rate-limit Patch
@graphql-mesh/plugin-response-cache Patch
@graphql-mesh/plugin-statsd Patch
@omnigraph/json-schema Patch
@omnigraph/openapi Patch
@omnigraph/raml Patch
auth0-example Patch
cloudflare-workers Patch
hasura-openbrewery-geodb Patch
hello-world-esm Patch
json-schema-hello-world Patch
json-schema-example Patch
json-schema-fhir Patch
json-schema-subscriptions Patch
mongoose-example Patch
neo4j-example Patch
javascript-wiki Patch
openapi-stackexchange Patch
openapi-stripe Patch
openapi-subscriptions Patch
openapi-youtrack Patch
reddit-example Patch
country-info-example Patch
soap-demo Patch
soap-netsuite Patch
chinook Patch
thrift-calculator Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

diff --git a/website/algolia-lockfile.json b/website/algolia-lockfile.json
index 36afabe95..a90c2e1e0 100644
--- a/website/algolia-lockfile.json
+++ b/website/algolia-lockfile.json
@@ -1,4 +1,16 @@
 [
+  {
+    "objectID": "mesh-docs-cache-storages-cache-introduction",
+    "headings": [],
+    "toc": [],
+    "content": "73efed27f8b33745e61c1bb45118567c",
+    "url": "https://www.graphql-mesh.com/docs/cache/cache-introduction",
+    "domain": "https://www.graphql-mesh.com/",
+    "hierarchy": ["Docs", "Cache Storages"],
+    "source": "Mesh",
+    "title": "Introduction",
+    "type": "Documentation"
+  },
   {
     "objectID": "mesh-docs-cache-storages-cfwkv",
     "headings": ["How to use?", "Config API Reference"],
@@ -159,6 +171,140 @@
     "title": "CLI commands",
     "type": "Documentation"
   },
+  {
+    "objectID": "mesh-docs-config-reference",
+    "headings": [
+      "`sources`",
+      "`transforms`",
+      "`additionalTypeDefs`",
+      "`additionalResolvers`",
+      "`plugins`",
+      "`additionalEnvelopPlugins`",
+      "`cache`",
+      "`serve`",
+      "`sdk`",
+      "`documents`",
+      "`customFetch`",
+      "`logger`",
+      "`merger`",
+      "`pubsub`",
+      "`skipSSLValidation`",
+      "`includeHttpDetailsInExtensions`",
+      "`codegen`",
+      "`require`"
+    ],
+    "toc": [
+      {
+        "children": [],
+        "title": "`sources`",
+        "anchor": "sources"
+      },
+      {
+        "children": [],
+        "title": "`transforms`",
+        "anchor": "transforms"
+      },
+      {
+        "children": [],
+        "title": "`additionalTypeDefs`",
+        "anchor": "additionaltypedefs"
+      },
+      {
+        "children": [],
+        "title": "`additionalResolvers`",
+        "anchor": "additionalresolvers"
+      },
+      {
+        "children": [],
+        "title": "`plugins`",
+        "anchor": "plugins"
+      },
+      {
+        "children": [],
+        "title": "`additionalEnvelopPlugins`",
+        "anchor": "additionalenvelopplugins"
+      },
+      {
+        "children": [],
+        "title": "`cache`",
+        "anchor": "cache"
+      },
+      {
+        "children": [
+          {
+            "children": [],
+            "title": "Serve config reference:",
+            "anchor": "serve-config-reference"
+          }
+        ],
+        "title": "`serve`",
+        "anchor": "serve"
+      },
+      {
+        "children": [
+          {
+            "children": [],
+            "title": "SDK config reference:",
+            "anchor": "sdk-config-reference"
+          }
+        ],
+        "title": "`sdk`",
+        "anchor": "sdk"
+      },
+      {
+        "children": [],
+        "title": "`documents`",
+        "anchor": "documents"
+      },
+      {
+        "children": [],
+        "title": "`customFetch`",
+        "anchor": "customfetch"
+      },
+      {
+        "children": [],
+        "title": "`logger`",
+        "anchor": "logger"
+      },
+      {
+        "children": [],
+        "title": "`merger`",
+        "anchor": "merger"
+      },
+      {
+        "children": [],
+        "title": "`pubsub`",
+        "anchor": "pubsub"
+      },
+      {
+        "children": [],
+        "title": "`skipSSLValidation`",
+        "anchor": "skipsslvalidation"
+      },
+      {
+        "children": [],
+        "title": "`includeHttpDetailsInExtensions`",
+        "anchor": "includehttpdetailsinextensions"
+      },
+      {
+        "children": [],
+        "title": "`codegen`",
+        "anchor": "codegen"
+      },
+      {
+        "children": [],
+        "title": "`require`",
+        "anchor": "require"
+      }
+    ],
+    "content": "a1b955ecfdbe2716ee2f95fb88b253ef",
+    "url": "https://www.graphql-mesh.com/docs/config-reference",
+    "domain": "https://www.graphql-mesh.com/",
+    "hierarchy": ["Docs"],
+    "source": "Mesh",
+    "title": "Config Reference",
+    "type": "Documentation"
+  },
   {
     "objectID": "mesh-docs-extend-custom-handler",
     "headings": [],
@@ -1432,7 +1578,7 @@
         "anchor": "config-api-reference"
       }
     ],
-    "content": "0a95d26a886583a0909a889068f157c8",
+    "content": "af1e3b47dc4623bfdee9c87f3a07b3df",
     "url": "https://www.graphql-mesh.com/docs/handlers/openapi",
     "domain": "https://www.graphql-mesh.com/",
     "hierarchy": ["Docs", "Source Handlers"],

@github-actions
Copy link
Contributor

github-actions bot commented Sep 29, 2022

🚀 Website Preview

The latest changes to the website are available as preview in: https://0c1e3fb0.graphql-mesh.pages.dev

@github-actions
Copy link
Contributor

github-actions bot commented Sep 29, 2022

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package Version Info
@graphql-mesh/cache-cfw-kv 0.0.33-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/cache-file 0.9.32-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/cache-localforage 0.6.47-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/cache-redis 0.10.32-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/cli 0.78.26-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/config 8.0.15-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/container 0.1.176-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/graphql 0.31.19-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/grpc 0.25.19-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/json-schema 0.35.20-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/mongoose 0.11.17-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/mysql 0.17.17-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/neo4j 0.20.20-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/odata 0.20.18-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/openapi 0.33.21-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/postgraphile 0.21.17-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/raml 0.8.20-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/soap 0.14.17-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/thrift 0.11.18-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/tuql 0.6.17-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/http 0.1.23-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/jit-executor 0.0.42-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
json-machete 0.15.4-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@omnigraph/json-schema 0.35.4-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@omnigraph/openapi 0.16.4-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@omnigraph/raml 0.7.26-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/merger-bare 0.15.33-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/merger-federation 0.12.31-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/merger-stitching 0.16.31-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-live-query 0.1.32-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-mock 0.0.24-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-newrelic 0.2.15-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-operation-field-permissions 0.0.7-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-prometheus 0.1.16-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-rate-limit 0.0.33-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-response-cache 0.1.34-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/plugin-statsd 0.0.16-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/runtime 0.44.15-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/store 0.8.50-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-cache 0.12.52-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-encapsulate 0.3.99-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-extend 0.10.62-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-federation 0.9.41-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-filter-schema 0.14.98-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-hoist-field 0.1.63-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-naming-convention 0.11.6-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-prefix 0.11.87-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-prune 0.0.73-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-rate-limit 0.1.65-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-rename 0.12.88-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-replace-field 0.3.96-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-resolvers-composition 0.12.96-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-snapshot 0.14.63-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/transform-type-merging 0.4.41-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/types 0.84.6-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎
@graphql-mesh/utils 0.41.17-alpha-20220929165908-13439fa3e npm ↗︎ unpkg ↗︎

@ardatan ardatan merged commit ffb3014 into master Sep 29, 2022
@ardatan ardatan deleted the config-doc branch October 18, 2022 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants