qol changes in overlay.yaml

Author: walker-tx

.devcontainer/README.md

@@ -1,9 +1,4 @@
 
-<div align="center">
-    <a href="https://codespaces.new/speakeasy-sdks/code-sample-api.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
-</div>
-<br>
-
 > **Remember to shutdown a GitHub Codespace when it is not in use!**
 
 # Dev Containers Quick Start

.speakeasy/gen.lock

@@ -1,14 +1,12 @@
 lockVersion: 2.0.0
-id: c7686174-7704-4859-9d59-8dab3c98a47f
+id: 74386feb-f8da-4ec0-8b02-29dfddf22161
 management:
-  docChecksum: c53d80182e179c30c3ef54a71a25bc0e
+  docChecksum: a0841885f1d2df6bf65c33550d1be776
   docVersion: 0.4.0
   speakeasyVersion: 1.463.1
   generationVersion: 2.486.6
   releaseVersion: 2.0.0
-  configChecksum: 1a0c6924656a2d352f9b86dc2654dcfd
-  repoURL: https://github.com/speakeasy-sdks/code-sample-api.git
-  installationURL: https://github.com/speakeasy-sdks/code-sample-api
+  configChecksum: 88c5e327e8ad8129a9654dc84dd0c36d
   published: true
 features:
   typescript:
@@ -19,6 +17,7 @@ features:
     envVarSecurityUsage: 0.1.2
     globalSecurity: 2.82.12
     globalSecurityCallbacks: 0.1.0
+    globalSecurityFlattening: 0.1.0
     globalServerURLs: 2.82.4
     globals: 2.82.1
     groups: 2.81.2
@@ -35,7 +34,6 @@ generatedFiles:
   - .eslintrc.cjs
   - .gitattributes
   - .npmignore
-  - CONTRIBUTING.md
   - FUNCTIONS.md
   - REACT_QUERY.md
   - RUNTIMES.md
@@ -45,9 +43,10 @@ generatedFiles:
   - docs/models/components/usagesnippet.md
   - docs/models/components/usagesnippets.md
   - docs/models/errors/errort.md
+  - docs/models/operations/getcodesamplesglobals.md
   - docs/models/operations/getcodesamplesrequest.md
   - docs/sdks/codesamples/README.md
-  - docs/sdks/sdk/README.md
+  - docs/sdks/speakeasycodesamples/README.md
   - jsr.json
   - package.json
   - src/core.ts
@@ -99,42 +98,14 @@ generatedFiles:
   - src/types/streams.ts
   - tsconfig.json
 examples:
-  generateCodeSamplePreview:
-    speakeasy-default-generate-code-sample-preview:
-      requestBody:
-        multipart/form-data: {"languages": ["<value>"], "schema_file": {}}
-      responses:
-        4XX:
-          application/json: {"message": "<value>", "status_code": 159498}
-        "200": {}
-  generateCodeSamplePreviewAsync:
-    speakeasy-default-generate-code-sample-preview-async:
-      requestBody:
-        multipart/form-data: {"languages": ["<value>", "<value>"], "schema_file": {}}
-      responses:
-        "202":
-          application/json: {"job_id": "<id>", "status": "pending"}
-        4XX:
-          application/json: {"message": "<value>", "status_code": 677743}
-  getCodeSamplePreviewAsync:
-    speakeasy-default-get-code-sample-preview-async:
-      parameters:
-        path:
-          jobID: "<id>"
-      responses:
-        "202":
-          application/json: {"status": "pending"}
-        4XX:
-          application/json: {"message": "<value>", "status_code": 893724}
-        "200": {}
   getCodeSamples:
     speakeasy-default-get-code-samples:
       parameters:
         query:
-          registry_url: "https://normal-making.name"
+          registry_url: "https://spec.speakeasy.com/org/ws/my-source"
       responses:
         2XX:
-          application/json: {"snippets": [{"operationId": "<id>", "language": "<value>", "code": "<value>"}, {"operationId": "<id>", "language": "<value>", "code": "<value>"}, {"operationId": "<id>", "language": "<value>", "code": "<value>"}]}
+          application/json: {"snippets": [{"operationId": "<id>", "language": "<value>", "code": "<value>"}, {"operationId": "<id>", "language": "<value>", "code": "<value>"}]}
         4XX:
-          application/json: {"message": "<value>", "status_code": 458049}
+          application/json: {"message": "<value>", "status_code": 558834}
 generatedTests: {}

.speakeasy/gen.yaml

@@ -3,7 +3,7 @@ generation:
   devContainers:
     enabled: true
     schemaPath: openapi.json
-  sdkClassName: SDK
+  sdkClassName: SpeakeasyCodeSamples
   maintainOpenAPIOrder: true
   usageSnippets:
     optionalPropertyRendering: withExample
@@ -42,7 +42,7 @@ typescript:
   methodArguments: require-security-and-request
   moduleFormat: commonjs
   outputModelSuffix: output
-  packageName: '@speakeasyapi/code-samples'
+  packageName: "@speakeasyapi/code-samples"
   responseFormat: flat
   templateVersion: v2
   useIndexModules: true

FUNCTIONS.md

@@ -19,21 +19,20 @@ specific category of applications.
 ## Example
 
 ```typescript
-import { SDKCore } from "@speakeasyapi/code-samples/core.js";
+import { SpeakeasyCodeSamplesCore } from "@speakeasyapi/code-samples/core.js";
 import { codeSamplesGet } from "@speakeasyapi/code-samples/funcs/codeSamplesGet.js";
 import { SDKValidationError } from "@speakeasyapi/code-samples/models/errors/sdkvalidationerror.js";
 
-// Use `SDKCore` for best tree-shaking performance.
+// Use `SpeakeasyCodeSamplesCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const sdk = new SDKCore({
-  security: {
-    apiKey: "<YOUR_API_KEY_HERE>",
-  },
+const speakeasyCodeSamples = new SpeakeasyCodeSamplesCore({
+  apiKey: "<YOUR_API_KEY_HERE>",
+  registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
 });
 
 async function run() {
-  const res = await codeSamplesGet(sdk, {
-    registryUrl: "https://normal-making.name",
+  const res = await codeSamplesGet(speakeasyCodeSamples, {
+    registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
   });
 
   switch (true) {

REACT_QUERY.md

@@ -18,14 +18,13 @@ your React app at the root or layout component. For example:
 
 ```tsx
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-import { SDKCore } from "@speakeasyapi/code-samples";
-import { SDKProvider } from "@speakeasyapi/code-samples/react-query";
+import { SpeakeasyCodeSamplesCore } from "@speakeasyapi/code-samples";
+import { SpeakeasyCodeSamplesProvider } from "@speakeasyapi/code-samples/react-query";
 
 const queryClient = new QueryClient();
-const sdk = new SDKCore({
-  security: {
-    apiKey: "<YOUR_API_KEY_HERE>",
-  },
+const speakeasyCodeSamples = new SpeakeasyCodeSamplesCore({
+  apiKey: "<YOUR_API_KEY_HERE>",
+  registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
 });
 
 // Retries are handled by the underlying SDK.
@@ -35,9 +34,9 @@ queryClient.setMutationDefaults(["@speakeasyapi/code-samples"], { retry: false }
 export function App() {
   return (
     <QueryClientProvider client={queryClient}>
-      <SDKProvider client={sdk}> 
+      <SpeakeasyCodeSamplesProvider client={speakeasyCodeSamples}> 
         {/* Your app logic starts here */}
-      </SDKProvider>
+      </SpeakeasyCodeSamplesProvider>
     </QueryClientProvider>
   );
 }
@@ -56,7 +55,7 @@ import { useCodeSamplesGet } from "@speakeasyapi/code-samples/react-query/codeSa
 
 export function Example() {
   const { data, error, status } = useCodeSamplesGet({
-    registryUrl: "https://normal-making.name",
+    registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
   });
 
   // Render the UI here...
@@ -76,7 +75,7 @@ export function ExampleWithOptions() {
   const [enabled, setEnabled] = useState(true);
   const { data, error, status } = useCodeSamplesGet(
     {
-      registryUrl: "https://normal-making.name",
+      registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
     },
     {
       // TanStack Query options:
@@ -158,21 +157,20 @@ hooks that integrate neatly with React Suspense.
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
 import { ErrorBoundary } from "react-error-boundary";
 
-import { SDKCore } from "@speakeasyapi/code-samples";
-import { SDKProvider } from "@speakeasyapi/code-samples/react-query";
+import { SpeakeasyCodeSamplesCore } from "@speakeasyapi/code-samples";
+import { SpeakeasyCodeSamplesProvider } from "@speakeasyapi/code-samples/react-query";
 import { useCodeSamplesGetSuspense } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 
 const queryClient = new QueryClient();
-const sdk = new SDKCore({
-  security: {
-    apiKey: "<YOUR_API_KEY_HERE>",
-  },
+const speakeasyCodeSamples = new SpeakeasyCodeSamplesCore({
+  apiKey: "<YOUR_API_KEY_HERE>",
+  registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
 });
 
 export function App() {
   return (
     <QueryClientProvider client={queryClient}>
-      <SDKProvider client={sdk}> 
+      <SpeakeasyCodeSamplesProvider client={speakeasyCodeSamples}> 
         <QueryErrorResetBoundary>
           {({ reset }) => (
             <ErrorBoundary
@@ -191,14 +189,14 @@ export function App() {
             </ErrorBoundary>
           )}
         </QueryErrorResetBoundary>
-      </SDKProvider>
+      </SpeakeasyCodeSamplesProvider>
     </QueryClientProvider>
   );
 }
 
 function Example() {
   const { data } = useCodeSamplesGetSuspense({
-    registryUrl: "https://normal-making.name",
+    registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
   });
 
   // Render the UI here...
@@ -218,19 +216,18 @@ import {
   HydrationBoundary,
   QueryClient,
 } from "@tanstack/react-query";
-import { SDKCore } from "@speakeasyapi/code-samples";
+import { SpeakeasyCodeSamplesCore } from "@speakeasyapi/code-samples";
 import { prefetchCodeSamplesGet } from "@speakeasyapi/code-samples/react-query/codeSamplesGet.js";
 
 export default async function Page() {
   const queryClient = new QueryClient();
-  const sdk = new SDKCore({
-    security: {
-      apiKey: "<YOUR_API_KEY_HERE>",
-    },
+  const speakeasyCodeSamples = new SpeakeasyCodeSamplesCore({
+    apiKey: "<YOUR_API_KEY_HERE>",
+    registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
   });
 
-  await prefetchCodeSamplesGet(queryClient, sdk, {
-    registryUrl: "https://normal-making.name",
+  await prefetchCodeSamplesGet(queryClient, speakeasyCodeSamples, {
+    registryUrl: "https://spec.speakeasy.com/org/ws/my-source",
   });
 
   return (