chore(docs): display pokemon schema in docs

graffle-js · Sep 27, 2024 · 1706187 · 1706187
1 parent 9acf22c
commit 1706187
Show file tree

Hide file tree

Showing 15 changed files with 141 additions and 126 deletions.
diff --git a/...__outputs__/10_transport-http/transport-http_extension_headers__dynamicHeaders.output.txt b/...__outputs__/10_transport-http/transport-http_extension_headers__dynamicHeaders.output.txt
@@ -4,7 +4,7 @@
   headers: Headers {
     accept: 'application/graphql-response+json; charset=utf-8, application/json; charset=utf-8',
     'content-type': 'application/json',
-    'x-sent-at-time': '1727447640287'
+    'x-sent-at-time': '1727448397817'
   },
   signal: undefined,
   method: 'post',

diff --git a/examples/__outputs__/20_output/output_envelope.output.txt b/examples/__outputs__/20_output/output_envelope.output.txt
@@ -16,7 +16,7 @@
     headers: Headers {
       'content-type': 'application/graphql-response+json; charset=utf-8',
       'content-length': '104',
-      date: 'Fri, 27 Sep 2024 14:34:00 GMT',
+      date: 'Fri, 27 Sep 2024 14:46:38 GMT',
       connection: 'keep-alive',
       'keep-alive': 'timeout=5'
     },

diff --git a/examples/__outputs__/60_extension/extension_opentelemetry__opentelemetry.output.txt b/examples/__outputs__/60_extension/extension_opentelemetry__opentelemetry.output.txt
@@ -9,14 +9,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'encode',
-  id: 'b198600c41de0595',
+  id: 'fbe410a54122c90d',
   kind: 0,
-  timestamp: 1727447640559000,
-  duration: 638.625,
+  timestamp: 1727448398866000,
+  duration: 578.375,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -33,14 +33,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'pack',
-  id: '83bc7ce70496db8d',
+  id: '8227407181a53485',
   kind: 0,
-  timestamp: 1727447640562000,
-  duration: 11628.625,
+  timestamp: 1727448398869000,
+  duration: 11708.416,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -57,14 +57,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'exchange',
-  id: 'd80122be49daa52a',
+  id: '03ac8e0024b76d4d',
   kind: 0,
-  timestamp: 1727447640574000,
-  duration: 20500.166,
+  timestamp: 1727448398881000,
+  duration: 21567.042,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -81,14 +81,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'unpack',
-  id: '0f3bf53d3bb99cfa',
+  id: '4567c2c4870bdfcd',
   kind: 0,
-  timestamp: 1727447640594000,
-  duration: 1112.417,
+  timestamp: 1727448398903000,
+  duration: 1110.708,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -105,14 +105,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'decode',
-  id: 'cfbb77f628c19bb9',
+  id: 'bfb9f2fb860b517d',
   kind: 0,
-  timestamp: 1727447640596000,
-  duration: 184.583,
+  timestamp: 1727448398904000,
+  duration: 184.167,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -129,14 +129,14 @@
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
+  traceId: '3cd37385228e87b5954715163c14fd17',
   parentId: undefined,
   traceState: undefined,
   name: 'request',
-  id: '235586747a904981',
+  id: '3a8b3fc4c48de84f',
   kind: 0,
-  timestamp: 1727447640558000,
-  duration: 37586.041,
+  timestamp: 1727448398865000,
+  duration: 38858.208,
   attributes: {},
   status: { code: 0 },
   events: [],

diff --git a/scripts/generate-examples-derivatives/generate-docs.ts b/scripts/generate-examples-derivatives/generate-docs.ts
@@ -67,7 +67,9 @@ const generateExamplePages = async (examplesTransformed: ExampleTransformed[]) =
   // Delete all existing to handle case of renaming or deleting examples.
   await deleteFiles({
     pattern: `./website/content/examples/**/*`,
-    options: { ignore: [`./website/content/examples/index.md`] },
+    options: {
+      ignore: [`./website/content/examples/index.md`, `./website/content/examples/01_about/**/*.md`],
+    },
   })
 
   await Promise.all(

diff --git a/website/.vitepress/config.ts b/website/.vitepress/config.ts
@@ -62,9 +62,11 @@ const sidebars = fixTitles(fixLinks(generateSidebar([
   },
 ]) as SidebarMulti))
 
-sidebars['/examples/'].items.unshift({ text: 'Introduction', link: '/' })
+sidebars['/examples/'].items.find(_ => _.text === 'About')!.items!.unshift({ text: 'Introduction', link: '/' })
 sidebars['/guides/'].items.unshift({ text: 'Introduction', link: '/' })
+
 const rootItems = sidebars['/guides/'].items.filter(_ => !_.items)
+
 sidebars['/guides/'].items = sidebars['/guides/'].items.filter(_ => _.items && _.items.length > 0)
 sidebars['/guides/'].items.unshift(...rootItems)
 

diff --git a/website/content/_snippets/examples/extension/opentelemetry.detail.md b/website/content/_snippets/examples/extension/opentelemetry.detail.md
@@ -37,14 +37,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'encode',
-  id: 'b198600c41de0595',
+  id: 'fbe410a54122c90d',
   kind: 0,
-  timestamp: 1727447640559000,
-  duration: 638.625,
+  timestamp: 1727448398866000,
+  duration: 578.375,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -64,14 +64,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'pack',
-  id: '83bc7ce70496db8d',
+  id: '8227407181a53485',
   kind: 0,
-  timestamp: 1727447640562000,
-  duration: 11628.625,
+  timestamp: 1727448398869000,
+  duration: 11708.416,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -91,14 +91,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'exchange',
-  id: 'd80122be49daa52a',
+  id: '03ac8e0024b76d4d',
   kind: 0,
-  timestamp: 1727447640574000,
-  duration: 20500.166,
+  timestamp: 1727448398881000,
+  duration: 21567.042,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -118,14 +118,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'unpack',
-  id: '0f3bf53d3bb99cfa',
+  id: '4567c2c4870bdfcd',
   kind: 0,
-  timestamp: 1727447640594000,
-  duration: 1112.417,
+  timestamp: 1727448398903000,
+  duration: 1110.708,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -145,14 +145,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'decode',
-  id: 'cfbb77f628c19bb9',
+  id: 'bfb9f2fb860b517d',
   kind: 0,
-  timestamp: 1727447640596000,
-  duration: 184.583,
+  timestamp: 1727448398904000,
+  duration: 184.167,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -172,14 +172,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
+  traceId: '3cd37385228e87b5954715163c14fd17',
   parentId: undefined,
   traceState: undefined,
   name: 'request',
-  id: '235586747a904981',
+  id: '3a8b3fc4c48de84f',
   kind: 0,
-  timestamp: 1727447640558000,
-  duration: 37586.041,
+  timestamp: 1727448398865000,
+  duration: 38858.208,
   attributes: {},
   status: { code: 0 },
   events: [],

diff --git a/website/content/_snippets/examples/extension/opentelemetry.md b/website/content/_snippets/examples/extension/opentelemetry.md
@@ -35,14 +35,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'encode',
-  id: 'b198600c41de0595',
+  id: 'fbe410a54122c90d',
   kind: 0,
-  timestamp: 1727447640559000,
-  duration: 638.625,
+  timestamp: 1727448398866000,
+  duration: 578.375,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -62,14 +62,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'pack',
-  id: '83bc7ce70496db8d',
+  id: '8227407181a53485',
   kind: 0,
-  timestamp: 1727447640562000,
-  duration: 11628.625,
+  timestamp: 1727448398869000,
+  duration: 11708.416,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -89,14 +89,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'exchange',
-  id: 'd80122be49daa52a',
+  id: '03ac8e0024b76d4d',
   kind: 0,
-  timestamp: 1727447640574000,
-  duration: 20500.166,
+  timestamp: 1727448398881000,
+  duration: 21567.042,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -116,14 +116,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'unpack',
-  id: '0f3bf53d3bb99cfa',
+  id: '4567c2c4870bdfcd',
   kind: 0,
-  timestamp: 1727447640594000,
-  duration: 1112.417,
+  timestamp: 1727448398903000,
+  duration: 1110.708,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -143,14 +143,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
-  parentId: '235586747a904981',
+  traceId: '3cd37385228e87b5954715163c14fd17',
+  parentId: '3a8b3fc4c48de84f',
   traceState: undefined,
   name: 'decode',
-  id: 'cfbb77f628c19bb9',
+  id: 'bfb9f2fb860b517d',
   kind: 0,
-  timestamp: 1727447640596000,
-  duration: 184.583,
+  timestamp: 1727448398904000,
+  duration: 184.167,
   attributes: {},
   status: { code: 0 },
   events: [],
@@ -170,14 +170,14 @@ console.log(data)
     }
   },
   instrumentationScope: { name: 'graffle', version: undefined, schemaUrl: undefined },
-  traceId: '9039f59347f6f75a8d39d0b53a9995e0',
+  traceId: '3cd37385228e87b5954715163c14fd17',
   parentId: undefined,
   traceState: undefined,
   name: 'request',
-  id: '235586747a904981',
+  id: '3a8b3fc4c48de84f',
   kind: 0,
-  timestamp: 1727447640558000,
-  duration: 37586.041,
+  timestamp: 1727448398865000,
+  duration: 38858.208,
   attributes: {},
   status: { code: 0 },
   events: [],