(CodeSamples)
REST APIs for retrieving Code Samples
- GenerateCodeSamplePreview - Generate Code Sample previews from a file and configuration parameters.
- GenerateCodeSamplePreviewAsync - Initiate asynchronous Code Sample preview generation from a file and configuration parameters, receiving an async JobID response for polling.
- Get - Retrieve usage snippets
- GetCodeSamplePreviewAsync - Poll for the result of an asynchronous Code Sample preview generation.
This endpoint generates Code Sample previews from a file and configuration parameters.
package main
import(
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"os"
"log"
)
func main() {
ctx := context.Background()
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
content, fileErr := os.Open("example.file")
if fileErr != nil {
panic(fileErr)
}
res, err := s.CodeSamples.GenerateCodeSamplePreview(ctx, shared.CodeSampleSchemaInput{
Language: "<value>",
SchemaFile: shared.SchemaFile{
Content: content,
FileName: "example.file",
},
})
if err != nil {
log.Fatal(err)
}
if res.UsageSnippets != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
request |
shared.CodeSampleSchemaInput | ✔️ | The request object to use for the request. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.GenerateCodeSamplePreviewResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| sdkerrors.Error | 4XX | application/json |
| sdkerrors.Error | 5XX | application/json |
This endpoint generates Code Sample previews from a file and configuration parameters, receiving an async JobID response for polling.
package main
import(
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"os"
"log"
)
func main() {
ctx := context.Background()
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
content, fileErr := os.Open("example.file")
if fileErr != nil {
panic(fileErr)
}
res, err := s.CodeSamples.GenerateCodeSamplePreviewAsync(ctx, shared.CodeSampleSchemaInput{
Language: "<value>",
SchemaFile: shared.SchemaFile{
Content: content,
FileName: "example.file",
},
})
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
request |
shared.CodeSampleSchemaInput | ✔️ | The request object to use for the request. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.GenerateCodeSamplePreviewAsyncResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| sdkerrors.Error | 4XX | application/json |
| sdkerrors.Error | 5XX | application/json |
Retrieve usage snippets from an OpenAPI document stored in the registry. Supports filtering by language and operation ID.
package main
import(
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
res, err := s.CodeSamples.Get(ctx, operations.GetCodeSamplesRequest{
Languages: []string{
"python",
"javascript",
},
MethodPaths: []operations.MethodPaths{
operations.MethodPaths{
Method: shared.HTTPMethodGet,
Path: "/pets",
},
},
OperationIds: []string{
"getPets",
},
RegistryURL: "https://spec.speakeasy.com/my-org/my-workspace/my-source",
})
if err != nil {
log.Fatal(err)
}
if res.UsageSnippets != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
request |
operations.GetCodeSamplesRequest | ✔️ | The request object to use for the request. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.GetCodeSamplesResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| sdkerrors.Error | 4XX | application/json |
| sdkerrors.SDKError | 5XX | */* |
Poll for the result of an asynchronous Code Sample preview generation.
package main
import(
"context"
speakeasyclientsdkgo "github.com/speakeasy-api/speakeasy-client-sdk-go/v3"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/shared"
"github.com/speakeasy-api/speakeasy-client-sdk-go/v3/pkg/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := speakeasyclientsdkgo.New(
speakeasyclientsdkgo.WithSecurity(shared.Security{
APIKey: speakeasyclientsdkgo.String("<YOUR_API_KEY_HERE>"),
}),
)
res, err := s.CodeSamples.GetCodeSamplePreviewAsync(ctx, operations.GetCodeSamplePreviewAsyncRequest{
JobID: "<id>",
})
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
request |
operations.GetCodeSamplePreviewAsyncRequest | ✔️ | The request object to use for the request. |
opts |
[]operations.Option | ➖ | The options for this request. |
*operations.GetCodeSamplePreviewAsyncResponse, error
| Error Type | Status Code | Content Type |
|---|---|---|
| sdkerrors.Error | 4XX | application/json |
| sdkerrors.Error | 5XX | application/json |