@@ -16,16 +16,17 @@ what they return.
1616
1717<!-- Start Table of Contents [toc] -->
1818## Table of Contents
19+ <!-- $toc-max-depth=2 -->
20+ * [ Livepeer Go SDK] ( #livepeer-go-sdk )
21+ * [ Documentation] ( #documentation )
22+ * [ SDK Installation] ( #sdk-installation )
23+ * [ SDK Example Usage] ( #sdk-example-usage )
24+ * [ Available Resources and Operations] ( #available-resources-and-operations )
25+ * [ Error Handling] ( #error-handling )
26+ * [ Custom HTTP Client] ( #custom-http-client )
27+ * [ Authentication] ( #authentication )
28+ * [ Retries] ( #retries )
1929
20- * [ SDK Installation] ( #sdk-installation )
21- * [ SDK Example Usage] ( #sdk-example-usage )
22- * [ Available Resources and Operations] ( #available-resources-and-operations )
23- * [ Retries] ( #retries )
24- * [ Error Handling] ( #error-handling )
25- * [ Server Selection] ( #server-selection )
26- * [ Custom HTTP Client] ( #custom-http-client )
27- * [ Authentication] ( #authentication )
28- * [ Special Types] ( #special-types )
2930<!-- End Table of Contents [toc] -->
3031
3132<!-- Start SDK Installation [installation] -->
@@ -103,6 +104,7 @@ func main() {
103104* [ Upscale] ( docs/sdks/generate/README.md#upscale ) - Upscale
104105* [ AudioToText] ( docs/sdks/generate/README.md#audiototext ) - Audio To Text
105106* [ SegmentAnything2] ( docs/sdks/generate/README.md#segmentanything2 ) - Segment Anything 2
107+ * [ Llm] ( docs/sdks/generate/README.md#llm ) - LLM
106108
107109
108110### [ Metrics] ( docs/sdks/metrics/README.md )
@@ -184,12 +186,16 @@ func main() {
184186<!-- Start Error Handling [errors] -->
185187## Error Handling
186188
187- Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass .
189+ Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.
188190
189- | Error Object | Status Code | Content Type |
190- | ------------------ | ------------------ | ------------------ |
191- | sdkerrors.Error | 404 | application/json |
192- | sdkerrors.SDKError | 4xx-5xx | * /* |
191+ By Default, an API error will return ` sdkerrors.SDKError ` . When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective * Errors* tables in SDK docs for more details on possible error types for each operation.
192+
193+ For example, the ` Get ` function may return the following errors:
194+
195+ | Error Type | Status Code | Content Type |
196+ | ------------------ | ----------- | ---------------- |
197+ | sdkerrors.Error | 404 | application/json |
198+ | sdkerrors.SDKError | 4XX, 5XX | \* /\* |
193199
194200### Example
195201
@@ -268,9 +274,9 @@ This can be a convenient way to configure timeouts, cookies, proxies, custom hea
268274
269275This SDK supports the following security scheme globally:
270276
271- | Name | Type | Scheme |
272- | ----------- | ------- ---- | ----------- |
273- | ` APIKey ` | http | HTTP Bearer |
277+ | Name | Type | Scheme |
278+ | -------- | ---- | ----------- |
279+ | ` APIKey ` | http | HTTP Bearer |
274280
275281You can configure it using the ` WithSecurity ` option when initializing the SDK client instance. For example:
276282``` go
@@ -342,13 +348,8 @@ func main() {
342348 Multistream: &components.Multistream {
343349 Targets: []components.Target {
344350 components.Target {
345- Profile: " 720p"
346- VideoOnly: livepeergo.Bool (false ),
347- ID: livepeergo.String (" PUSH123"
348- Spec: &components.TargetSpec {
349- Name: livepeergo.String (" My target"
350- URL: " rtmps://live.my-service.tv/channel/secretKey"
351- },
351+ Profile: " 720p0"
352+ ID: livepeergo.String (" PUSH123"
352353 },
353354 },
354355 },
@@ -364,12 +365,6 @@ func main() {
364365```
365366<!-- End Authentication [security] -->
366367
367- <!-- Start Special Types [types] -->
368- ## Special Types
369-
370-
371- <!-- End Special Types [types] -->
372-
373368<!-- Start Retries [retries] -->
374369## Retries
375370
@@ -447,13 +442,8 @@ func main() {
447442 Multistream: &components.Multistream {
448443 Targets: []components.Target {
449444 components.Target {
450- Profile: " 720p"
451- VideoOnly: livepeergo.Bool (false ),
452- ID: livepeergo.String (" PUSH123"
453- Spec: &components.TargetSpec {
454- Name: livepeergo.String (" My target"
455- URL: " rtmps://live.my-service.tv/channel/secretKey"
456- },
445+ Profile: " 720p0"
446+ ID: livepeergo.String (" PUSH123"
457447 },
458448 },
459449 },
@@ -560,13 +550,8 @@ func main() {
560550 Multistream: &components.Multistream {
561551 Targets: []components.Target {
562552 components.Target {
563- Profile: " 720p"
564- VideoOnly: livepeergo.Bool (false ),
565- ID: livepeergo.String (" PUSH123"
566- Spec: &components.TargetSpec {
567- Name: livepeergo.String (" My target"
568- URL: " rtmps://live.my-service.tv/channel/secretKey"
569- },
553+ Profile: " 720p0"
554+ ID: livepeergo.String (" PUSH123"
570555 },
571556 },
572557 },
0 commit comments