Skip to content

Commit 7a4e4c7

Browse files
committed
Sync open source content 🐝 (from d5a70a33e78da19f49cdabb21f17285f1ea1b778)
1 parent 829df01 commit 7a4e4c7

9 files changed

Lines changed: 11 additions & 29 deletions

File tree

‎docs/languages/csharp/oss-comparison-csharp.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ To create a C# SDK from the `petstore.yaml` specification file using Speakeasy,
364364
365365
```bash
366366
# Generate Pet store SDK using Speakeasy CLI generator
367-
speakeasy generate sdk --schema petstore.yaml --lang csharp --out petstore-sdk-csharp-speakeasy
367+
speakeasy quickstart
368368
```
369369

370370
The generator will return some logging results while the SDK is being created and a success indicator should appear upon completion.

‎docs/languages/golang/oss-comparison-go.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -381,10 +381,7 @@ Finally, we'll generate an SDK using the Speakeasy CLI.
381381

382382
```bash
383383
# Generate Petstore SDK using Speakeasy go generator
384-
speakeasy generate sdk \
385-
--schema petstore.yaml \
386-
--lang go \
387-
--out ./petstore-sdk-go-speakeasy/
384+
speakeasy quickstart
388385
```
389386

390387
This command prints a log of warnings and information, then completes successfully.

‎docs/languages/java/oss-comparison-java.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -296,10 +296,7 @@ Create a Java SDK from the `petstore.yaml` specification file using Speakeasy by
296296

297297
```bash
298298
# Generate Petstore SDK using Speakeasy java generator
299-
speakeasy generate sdk \
300-
--schema petstore.yaml \
301-
--lang java \
302-
--out ./sdks/petstore-sdk-java-speakeasy/
299+
speakeasy quickstart
303300
```
304301

305302
The generator will return some logging results while the SDK is being created and a success indicator on completion.

‎docs/languages/php/oss-comparison-php.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ The [OpenAPI Generator roadmap](https://openapi-generator.tech/docs/roadmap) has
153153
Next, we'll create an SDK using the Speakeasy CLI with the command below.
154154

155155
```bash
156-
docker run --rm -v "./app:/app" seimage speakeasy generate sdk --schema /app/schema.yaml --lang php --out /app/se
156+
docker run --rm -v "./app:/app" seimage speakeasy quickstart
157157
```
158158

159159
Speakeasy gives multiple warnings about `xml request bodies are not currently supported` and creates the following folders.

‎docs/languages/python/oss-comparison-python.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ The generator warned us in the terminal that `Generation using 3.1.0 specs is in
157157
Next, we'll create an SDK using the Speakeasy CLI with the command below.
158158

159159
```bash
160-
docker run --rm -v "./app:/app" seimage speakeasy generate sdk --schema /app/petstore31.yaml --lang python --out /app/se
160+
docker run --rm -v "./app:/app" seimage speakeasy quickstart
161161
```
162162

163163
Speakeasy creates the following folders.

‎docs/languages/typescript/oss-comparison-ts.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,10 +310,7 @@ To create a TypeScript SDK using the Speakeasy CLI, run the following in the ter
310310

311311
```bash
312312
# Create Petstore SDK using Speakeasy TypeScript generator
313-
speakeasy generate sdk \
314-
--schema petstore.yaml \
315-
--lang typescript \
316-
--out ./petstore-sdk-speakeasy/
313+
speakeasy quickstart
317314
```
318315

319316
The command above creates a new directory called `petstore-sdk-speakeasy`, with the following structure:

‎docs/speakeasy-reference/cli/mise-toolkit.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ To use Speakeasy CLI with mise in CI/CD pipelines:
154154
run: mise use aqua:speakeasy-api/speakeasy
155155

156156
- name: Use Speakeasy CLI
157-
run: speakeasy generate sdk
157+
run: speakeasy quickstart
158158
env:
159159
SPEAKEASY_API_KEY: ${{ secrets.SPEAKEASY_API_KEY }}
160160
```

‎openapi/frameworks/goa.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ speakeasy help;
383383
You now have `app/gen/http/openapi3.yaml` and Speakeasy, so you can build the SDK. In the container terminal, run:
384384
385385
```bash
386-
speakeasy generate sdk --schema /go/src/app/gen/http/openapi3.yaml --lang typescript --out /go/src/app/sdk
386+
speakeasy quickstart
387387
```
388388
389389
The output should be:

‎openapi/frameworks/typespec.mdx‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -841,10 +841,7 @@ speakeasy --version
841841
Then, generate a TypeScript SDK using the following command:
842842

843843
```bash Terminal
844-
speakeasy generate sdk \
845-
--schema tsp-output/@typespec/openapi3/openapi.yaml \
846-
--lang typescript \
847-
--out ./sdks/bookstore-ts
844+
speakeasy quickstart
848845
```
849846

850847
This command generates a TypeScript SDK for the API defined in the OpenAPI document. The SDK will be placed in the `sdks/bookstore-ts` directory.
@@ -866,21 +863,15 @@ tsp compile main.tsp --emit @typespec/openapi3
866863
2. Then use Speakeasy to generate the SDK:
867864

868865
```bash
869-
speakeasy generate sdk \
870-
--schema tsp-output/@typespec/openapi3/openapi.yaml \
871-
--lang typescript \
872-
--out ./sdks/bookstore-ts
866+
speakeasy quickstart
873867
```
874868

875869
This will create a TypeScript SDK in the `./sdks/bookstore-ts` directory.
876870

877871
Now that we've added the `x-speakeasy-retries` extension to the `listPublications` operation in the TypeSpec specification, we can use Speakeasy to recreate the SDK:
878872

879873
```bash Terminal
880-
speakeasy generate sdk \
881-
--schema tsp-output/@typespec/openapi3/openapi.yaml \
882-
--lang typescript \
883-
--out ./sdks/bookstore-ts
874+
speakeasy quickstart
884875
```
885876

886877
## Common TypeSpec Pitfalls and Possible Solutions

0 commit comments

Comments
 (0)