Skip to content

Commit

Permalink
chore: add openapi tag to satisfy global sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
gfyrag committed Jan 31, 2025
1 parent 95c8317 commit bf04cc7
Show file tree
Hide file tree
Showing 14 changed files with 523 additions and 541 deletions.
4 changes: 2 additions & 2 deletions openapi/v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ paths:
/_/info:
get:
tags:
- ledger
- ledger.v2
summary: Show server information
operationId: v2GetInfo
x-speakeasy-name-override: GetInfo
Expand Down Expand Up @@ -38,7 +38,7 @@ paths:
/_/metrics:
get:
tags:
- ledger
- ledger.v2
summary: Read in memory metrics
operationId: getMetrics
x-speakeasy-name-override: GetMetrics
Expand Down
36 changes: 18 additions & 18 deletions pkg/client/.speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: a9ac79e1-e429-4ee3-96c4-ec973f19bec3
management:
docChecksum: a75fbcee4705d8d6603062086b542987
docChecksum: 66467c4916574601e600551d938bede8
docVersion: v1
speakeasyVersion: 1.351.0
generationVersion: 2.384.1
releaseVersion: 0.5.1
configChecksum: c054a60832022bfc610a27df523d0e92
releaseVersion: 0.5.2
configChecksum: cbb85382da20101bd1a7a4eb33420e1d
features:
go:
additionalDependencies: 0.1.0
Expand Down Expand Up @@ -53,8 +53,6 @@ generatedFiles:
- internal/utils/retries.go
- internal/utils/security.go
- internal/utils/utils.go
- /models/operations/v2getinfo.go
- /models/operations/getmetrics.go
- /models/operations/getinfo.go
- /models/operations/getledgerinfo.go
- /models/operations/countaccounts.go
Expand All @@ -75,6 +73,8 @@ generatedFiles:
- /models/operations/getbalances.go
- /models/operations/getbalancesaggregated.go
- /models/operations/listlogs.go
- /models/operations/v2getinfo.go
- /models/operations/getmetrics.go
- /models/operations/v2listledgers.go
- /models/operations/v2getledger.go
- /models/operations/v2createledger.go
Expand All @@ -100,15 +100,11 @@ generatedFiles:
- /models/operations/v2listlogs.go
- /models/operations/v2importlogs.go
- /models/operations/v2exportlogs.go
- /models/sdkerrors/v2errorresponse.go
- /models/sdkerrors/errorresponse.go
- /models/components/v2errorsenum.go
- /models/components/v2configinforesponse.go
- /models/components/httpmetadata.go
- /models/components/configinforesponse.go
- /models/components/configinfo.go
- /models/components/config.go
- /models/components/ledgerstorage.go
- /models/components/httpmetadata.go
- /models/components/errorsenum.go
- /models/components/ledgerinforesponse.go
- /models/components/ledgerinfo.go
Expand Down Expand Up @@ -137,6 +133,8 @@ generatedFiles:
- /models/components/aggregatebalancesresponse.go
- /models/components/logscursorresponse.go
- /models/components/log.go
- /models/components/v2errorsenum.go
- /models/components/v2configinforesponse.go
- /models/components/v2ledgerlistresponse.go
- /models/components/v2ledger.go
- /models/components/v2getledgerresponse.go
Expand Down Expand Up @@ -172,8 +170,8 @@ generatedFiles:
- /models/components/v2logscursorresponse.go
- /models/components/v2log.go
- /models/components/security.go
- docs/models/operations/v2getinforesponse.md
- docs/models/operations/getmetricsresponse.md
- /models/sdkerrors/errorresponse.go
- /models/sdkerrors/v2errorresponse.go
- docs/models/operations/getinforesponse.md
- docs/models/operations/getledgerinforequest.md
- docs/models/operations/getledgerinforesponse.md
Expand Down Expand Up @@ -214,6 +212,8 @@ generatedFiles:
- docs/models/operations/getbalancesaggregatedresponse.md
- docs/models/operations/listlogsrequest.md
- docs/models/operations/listlogsresponse.md
- docs/models/operations/v2getinforesponse.md
- docs/models/operations/getmetricsresponse.md
- docs/models/operations/v2listledgersrequest.md
- docs/models/operations/v2listledgersresponse.md
- docs/models/operations/v2getledgerrequest.md
Expand Down Expand Up @@ -265,15 +265,11 @@ generatedFiles:
- docs/models/operations/v2importlogsresponse.md
- docs/models/operations/v2exportlogsrequest.md
- docs/models/operations/v2exportlogsresponse.md
- docs/models/sdkerrors/v2errorresponse.md
- docs/models/sdkerrors/errorresponse.md
- docs/models/components/v2errorsenum.md
- docs/models/components/v2configinforesponse.md
- docs/models/components/httpmetadata.md
- docs/models/components/configinforesponse.md
- docs/models/components/configinfo.md
- docs/models/components/config.md
- docs/models/components/ledgerstorage.md
- docs/models/components/httpmetadata.md
- docs/models/components/errorsenum.md
- docs/models/components/ledgerinforesponse.md
- docs/models/components/storage.md
Expand Down Expand Up @@ -311,6 +307,8 @@ generatedFiles:
- docs/models/components/logscursorresponse.md
- docs/models/components/type.md
- docs/models/components/log.md
- docs/models/components/v2errorsenum.md
- docs/models/components/v2configinforesponse.md
- docs/models/components/v2ledgerlistresponsecursor.md
- docs/models/components/v2ledgerlistresponse.md
- docs/models/components/v2ledger.md
Expand Down Expand Up @@ -363,9 +361,11 @@ generatedFiles:
- docs/models/components/v2logtype.md
- docs/models/components/v2log.md
- docs/models/components/security.md
- docs/models/sdkerrors/errorresponse.md
- docs/models/sdkerrors/v2errorresponse.md
- docs/sdks/formance/README.md
- docs/models/operations/option.md
- docs/sdks/ledger/README.md
- docs/models/operations/option.md
- docs/sdks/v1/README.md
- docs/sdks/v2/README.md
- USAGE.md
Expand Down
2 changes: 1 addition & 1 deletion pkg/client/.speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
go:
version: 0.5.1
version: 0.5.2
additionalDependencies: {}
allowUnknownFieldsInWeakUnions: false
clientServerStatusCodesAsErrors: true
Expand Down
43 changes: 20 additions & 23 deletions pkg/client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx)
res, err := s.Ledger.V1.GetInfo(ctx)
if err != nil {
log.Fatal(err)
}
if res.V2ConfigInfoResponse != nil {
if res.ConfigInfoResponse != nil {
// handle response
}
}
Expand All @@ -84,11 +84,6 @@ func main() {
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

### [Ledger](docs/sdks/ledger/README.md)

* [GetInfo](docs/sdks/ledger/README.md#getinfo) - Show server information
* [GetMetrics](docs/sdks/ledger/README.md#getmetrics) - Read in memory metrics

### [Ledger.V1](docs/sdks/v1/README.md)

* [GetInfo](docs/sdks/v1/README.md#getinfo) - Show server information
Expand All @@ -114,6 +109,8 @@ func main() {

### [Ledger.V2](docs/sdks/v2/README.md)

* [GetInfo](docs/sdks/v2/README.md#getinfo) - Show server information
* [GetMetrics](docs/sdks/v2/README.md#getmetrics) - Read in memory metrics
* [ListLedgers](docs/sdks/v2/README.md#listledgers) - List ledgers
* [GetLedger](docs/sdks/v2/README.md#getledger) - Get a ledger
* [CreateLedger](docs/sdks/v2/README.md#createledger) - Create a ledger
Expand Down Expand Up @@ -168,7 +165,7 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx, operations.WithRetries(
res, err := s.Ledger.V1.GetInfo(ctx, operations.WithRetries(
retry.Config{
Strategy: "backoff",
Backoff: &retry.BackoffStrategy{
Expand All @@ -182,7 +179,7 @@ func main() {
if err != nil {
log.Fatal(err)
}
if res.V2ConfigInfoResponse != nil {
if res.ConfigInfoResponse != nil {
// handle response
}
}
Expand Down Expand Up @@ -221,11 +218,11 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx)
res, err := s.Ledger.V1.GetInfo(ctx)
if err != nil {
log.Fatal(err)
}
if res.V2ConfigInfoResponse != nil {
if res.ConfigInfoResponse != nil {
// handle response
}
}
Expand All @@ -238,10 +235,10 @@ func main() {

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.

| Error Object | Status Code | Content Type |
| ------------------------- | ------------------------- | ------------------------- |
| sdkerrors.V2ErrorResponse | default | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------- | ----------------------- | ----------------------- |
| sdkerrors.ErrorResponse | default | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |

### Example

Expand All @@ -266,10 +263,10 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx)
res, err := s.Ledger.V1.GetInfo(ctx)
if err != nil {

var e *sdkerrors.V2ErrorResponse
var e *sdkerrors.ErrorResponse
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
Expand Down Expand Up @@ -319,11 +316,11 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx)
res, err := s.Ledger.V1.GetInfo(ctx)
if err != nil {
log.Fatal(err)
}
if res.V2ConfigInfoResponse != nil {
if res.ConfigInfoResponse != nil {
// handle response
}
}
Expand Down Expand Up @@ -354,11 +351,11 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx)
res, err := s.Ledger.V1.GetInfo(ctx)
if err != nil {
log.Fatal(err)
}
if res.V2ConfigInfoResponse != nil {
if res.ConfigInfoResponse != nil {
// handle response
}
}
Expand Down Expand Up @@ -433,11 +430,11 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx)
res, err := s.Ledger.V1.GetInfo(ctx)
if err != nil {
log.Fatal(err)
}
if res.V2ConfigInfoResponse != nil {
if res.ConfigInfoResponse != nil {
// handle response
}
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/client/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ func main() {
)

ctx := context.Background()
res, err := s.Ledger.GetInfo(ctx)
res, err := s.Ledger.V1.GetInfo(ctx)
if err != nil {
log.Fatal(err)
}
if res.V2ConfigInfoResponse != nil {
if res.ConfigInfoResponse != nil {
// handle response
}
}
Expand Down
Loading

0 comments on commit bf04cc7

Please sign in to comment.