mirror of
https://github.com/LukeHagar/Coolify-TypeScript-SDK.git
synced 2025-12-10 12:27:46 +00:00
Saving initial generation
This commit is contained in:
30
.devcontainer/README.md
Normal file
30
.devcontainer/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
||||
|
||||
# Dev Containers Quick Start
|
||||
|
||||
The default location for usage snippets is the `samples` directory.
|
||||
|
||||
## Running a Usage Sample
|
||||
|
||||
A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
|
||||
|
||||
```
|
||||
ts-node root.ts
|
||||
```
|
||||
|
||||
## Generating Additional Usage Samples
|
||||
|
||||
The speakeasy CLI allows you to generate more usage snippets. Here's how:
|
||||
|
||||
- To generate a sample for a specific operation by providing an operation ID, use:
|
||||
|
||||
```
|
||||
speakeasy generate usage -s https://raw.githubusercontent.com/coollabsio/documentation-coolify/refs/heads/main/openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples
|
||||
```
|
||||
|
||||
- To generate samples for an entire namespace (like a tag or group name), use:
|
||||
|
||||
```
|
||||
speakeasy generate usage -s https://raw.githubusercontent.com/coollabsio/documentation-coolify/refs/heads/main/openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples
|
||||
```
|
||||
Reference in New Issue
Block a user