Skip to content

Commit 7844f7e

Browse files
committed
convert to new code samples api
1 parent 900531c commit 7844f7e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1343
-1505
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/react-query
2+
/.speakeasy/reports
13
/models
24
/models/errors
35
/types

.npmignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
**/*
2+
!/FUNCTIONS.md
3+
!/RUNTIMES.md
4+
!/REACT_QUERY.md
25
!/**/*.ts
36
!/**/*.js
47
!/**/*.map

.speakeasy/gen.lock

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,33 @@
11
lockVersion: 2.0.0
22
id: c7686174-7704-4859-9d59-8dab3c98a47f
33
management:
4-
docChecksum: c43b59c2013089d85388de072b9a0283
4+
docChecksum: c53d80182e179c30c3ef54a71a25bc0e
55
docVersion: 0.4.0
6-
speakeasyVersion: 1.441.0
7-
generationVersion: 2.460.1
8-
releaseVersion: 1.0.0
9-
configChecksum: 71305aa56b02d549908d5e2cbee7c48f
6+
speakeasyVersion: 1.463.1
7+
generationVersion: 2.486.6
8+
releaseVersion: 2.0.0
9+
configChecksum: 1a0c6924656a2d352f9b86dc2654dcfd
1010
repoURL: https://github.com/speakeasy-sdks/code-sample-api.git
1111
installationURL: https://github.com/speakeasy-sdks/code-sample-api
1212
published: true
1313
features:
1414
typescript:
15-
acceptHeaders: 2.81.2
1615
additionalDependencies: 0.1.0
17-
core: 3.18.5
16+
core: 3.18.12
1817
defaultEnabledRetries: 0.1.0
1918
devContainers: 2.90.0
20-
downloadStreams: 0.1.1
21-
enumUnions: 0.1.0
2219
envVarSecurityUsage: 0.1.2
23-
flattening: 2.82.0
24-
globalSecurity: 2.82.11
20+
globalSecurity: 2.82.12
2521
globalSecurityCallbacks: 0.1.0
2622
globalServerURLs: 2.82.4
2723
globals: 2.82.1
2824
groups: 2.81.2
2925
nameOverrides: 2.81.2
26+
reactQueryHooks: 0.2.2
3027
responseFormat: 0.2.3
3128
retries: 2.83.0
3229
sdkHooks: 0.2.0
3330
serverIDs: 2.81.2
34-
tests: 0.7.0
35-
uploadStreams: 0.1.0
3631
generatedFiles:
3732
- .devcontainer/README.md
3833
- .devcontainer/devcontainer.json
@@ -42,27 +37,21 @@ generatedFiles:
4237
- .npmignore
4338
- CONTRIBUTING.md
4439
- FUNCTIONS.md
40+
- REACT_QUERY.md
4541
- RUNTIMES.md
4642
- USAGE.md
4743
- docs/lib/utils/retryconfig.md
48-
- docs/models/components/codesampleschemainput.md
49-
- docs/models/components/codesamplesjobstatus.md
50-
- docs/models/components/schemafile.md
5144
- docs/models/components/security.md
45+
- docs/models/components/usagesnippet.md
46+
- docs/models/components/usagesnippets.md
5247
- docs/models/errors/errort.md
53-
- docs/models/operations/generatecodesamplepreviewasyncresponsebody.md
54-
- docs/models/operations/generatecodesamplepreviewresponse.md
55-
- docs/models/operations/getcodesamplepreviewasyncrequest.md
56-
- docs/models/operations/getcodesamplepreviewasyncresponse.md
57-
- docs/models/operations/getcodesamplepreviewasyncresponsebody.md
48+
- docs/models/operations/getcodesamplesrequest.md
5849
- docs/sdks/codesamples/README.md
5950
- docs/sdks/sdk/README.md
6051
- jsr.json
6152
- package.json
6253
- src/core.ts
63-
- src/funcs/codesamplesGetAsync.ts
64-
- src/funcs/codesamplesPreview.ts
65-
- src/funcs/codesamplesPreviewAsync.ts
54+
- src/funcs/codeSamplesGet.ts
6655
- src/hooks/hooks.ts
6756
- src/hooks/index.ts
6857
- src/hooks/types.ts
@@ -82,19 +71,21 @@ generatedFiles:
8271
- src/lib/sdks.ts
8372
- src/lib/security.ts
8473
- src/lib/url.ts
85-
- src/models/components/codesampleschemainput.ts
86-
- src/models/components/codesamplesjobstatus.ts
8774
- src/models/components/index.ts
8875
- src/models/components/security.ts
76+
- src/models/components/usagesnippet.ts
77+
- src/models/components/usagesnippets.ts
8978
- src/models/errors/apierror.ts
9079
- src/models/errors/error.ts
9180
- src/models/errors/httpclienterrors.ts
9281
- src/models/errors/index.ts
9382
- src/models/errors/sdkvalidationerror.ts
94-
- src/models/operations/generatecodesamplepreview.ts
95-
- src/models/operations/generatecodesamplepreviewasync.ts
96-
- src/models/operations/getcodesamplepreviewasync.ts
83+
- src/models/operations/getcodesamples.ts
9784
- src/models/operations/index.ts
85+
- src/react-query/_context.tsx
86+
- src/react-query/_types.ts
87+
- src/react-query/codeSamplesGet.ts
88+
- src/react-query/index.ts
9889
- src/sdk/codesamples.ts
9990
- src/sdk/index.ts
10091
- src/sdk/sdk.ts
@@ -136,3 +127,14 @@ examples:
136127
4XX:
137128
application/json: {"message": "<value>", "status_code": 893724}
138129
"200": {}
130+
getCodeSamples:
131+
speakeasy-default-get-code-samples:
132+
parameters:
133+
query:
134+
registry_url: "https://normal-making.name"
135+
responses:
136+
2XX:
137+
application/json: {"snippets": [{"operationId": "<id>", "language": "<value>", "code": "<value>"}, {"operationId": "<id>", "language": "<value>", "code": "<value>"}, {"operationId": "<id>", "language": "<value>", "code": "<value>"}]}
138+
4XX:
139+
application/json: {"message": "<value>", "status_code": 458049}
140+
generatedTests: {}

.speakeasy/gen.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ generation:
99
optionalPropertyRendering: withExample
1010
useClassNamesForArrayFields: true
1111
fixes:
12-
nameResolutionDec2023: true
13-
parameterOrderingFeb2024: true
14-
requestResponseComponentNamesFeb2024: true
12+
nameResolutionDec2023: false
13+
parameterOrderingFeb2024: false
14+
requestResponseComponentNamesFeb2024: false
1515
auth:
1616
oAuth2ClientCredentialsEnabled: false
1717
oAuth2PasswordEnabled: false
1818
typescript:
19-
version: 1.0.0
19+
version: 2.0.0
2020
additionalDependencies:
2121
dependencies: {}
2222
devDependencies: {}
@@ -25,6 +25,7 @@ typescript:
2525
author: Speakeasy
2626
clientServerStatusCodesAsErrors: true
2727
defaultErrorName: APIError
28+
enableReactQuery: true
2829
enumFormat: enum
2930
flattenGlobalSecurity: true
3031
flatteningOrder: body-first

.speakeasy/workflow.lock

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
speakeasyVersion: 1.441.0
1+
speakeasyVersion: 1.463.1
22
sources:
33
speakeasy-OAS:
44
sourceNamespace: speakeasy-oas
@@ -13,8 +13,6 @@ targets:
1313
sourceNamespace: speakeasy-oas
1414
sourceRevisionDigest: sha256:3ce4076b437393a6fb3f102ac083c3d05a6e9e3e6daf47f99c6c4cf3a65b0e4c
1515
sourceBlobDigest: sha256:785a83db337cb309aac27c4a805335396096391c489e7140d753840935ef8e55
16-
codeSamplesNamespace: speakeasy-oas-code-samples
17-
codeSamplesRevisionDigest: sha256:e5da15a44c4e0e5137d00c8cba0a0349cac5002cb0232608b12c6d34a517724f
1816
workflow:
1917
workflowVersion: 1.0.0
2018
speakeasyVersion: latest
@@ -26,7 +24,7 @@ workflow:
2624
- location: overlay.yaml
2725
transformations:
2826
- filterOperations:
29-
operations: generateCodeSamplePreview, generateCodeSamplePreviewAsync, getCodeSamplePreviewAsync
27+
operations: getCodeSamples
3028
include: true
3129
registry:
3230
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-public/speakeasy-oas

.speakeasy/workflow.yaml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
workflowVersion: 1.0.0
22
speakeasyVersion: latest
33
sources:
4-
speakeasy-OAS:
5-
inputs:
6-
- location: https://www.speakeasy.com/openapi.yaml
7-
overlays:
8-
- location: overlay.yaml
9-
transformations:
10-
- filterOperations:
11-
operations: generateCodeSamplePreview, generateCodeSamplePreviewAsync, getCodeSamplePreviewAsync
12-
include: true
13-
registry:
14-
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-public/speakeasy-oas
4+
speakeasy-OAS:
5+
inputs:
6+
- location: https://www.speakeasy.com/openapi.yaml
7+
overlays:
8+
- location: overlay.yaml
9+
transformations:
10+
- filterOperations:
11+
operations: getCodeSamples
12+
include: true
13+
registry:
14+
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-public/speakeasy-oas
1515
targets:
16-
code_samples_typescript_sdk:
17-
target: typescript
18-
source: speakeasy-OAS
19-
publish:
20-
npm:
21-
token: $npm_token
22-
codeSamples:
23-
registry:
24-
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-public/speakeasy-oas-code-samples
25-
blocking: false
16+
code_samples_typescript_sdk:
17+
target: typescript
18+
source: speakeasy-OAS
19+
publish:
20+
npm:
21+
token: $npm_token
22+
codeSamples:
23+
registry:
24+
location: registry.speakeasyapi.dev/speakeasy-self/speakeasy-public/speakeasy-oas-code-samples
25+
blocking: false

FUNCTIONS.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ specific category of applications.
2020

2121
```typescript
2222
import { SDKCore } from "@speakeasyapi/code-samples/core.js";
23-
import { codesamplesPreview } from "@speakeasyapi/code-samples/funcs/codesamplesPreview.js";
23+
import { codeSamplesGet } from "@speakeasyapi/code-samples/funcs/codeSamplesGet.js";
2424
import { SDKValidationError } from "@speakeasyapi/code-samples/models/errors/sdkvalidationerror.js";
25-
import { openAsBlob } from "node:fs";
2625

2726
// Use `SDKCore` for best tree-shaking performance.
2827
// You can create one instance of it to use across an application.
@@ -33,11 +32,8 @@ const sdk = new SDKCore({
3332
});
3433

3534
async function run() {
36-
const res = await codesamplesPreview(sdk, {
37-
languages: [
38-
"<value>",
39-
],
40-
schemaFile: await openAsBlob("example.file"),
35+
const res = await codeSamplesGet(sdk, {
36+
registryUrl: "https://normal-making.name",
4137
});
4238

4339
switch (true) {

0 commit comments

Comments
 (0)