[pull] main from hookdeck:main #57
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…for v0.12 Outpost release
This commit addresses final SDK release preparation.
OpenAPI Spec Changes:
- Add reusable DestinationType enum schema to components/schemas
- Refactor /tenants/{tenant_id}/destinations type parameter to reference
DestinationType enum instead of inline duplicate enum definitions
- Fixes enum duplication issue that generated ListTenantDestinationsTypeEnum1
and ListTenantDestinationsTypeEnum2 (now uses single components.DestinationType)
SDK Configuration:
- Update all SDK gen.yaml files: set requestBodyFieldName to 'params' for
consistent request body field naming across TypeScript, Python, and Go SDKs
- TypeScript: sdks/outpost-typescript/.speakeasy/gen.yaml
- Python: sdks/outpost-python/.speakeasy/gen.yaml
- Go: sdks/outpost-go/.speakeasy/gen.yaml
Migration Guide Updates:
- Add 'Version Information' section clarifying distinction between Outpost
platform version (v0.12) and SDK versions
- Make SDK sections generic (not TypeScript-specific) with TypeScript examples
- Update breaking changes table and upgrade checklist to reflect all SDKs
SDK Client & Test Updates:
- Update sdk-client.ts to use 'params' instead of 'destinationCreate'
- Remove 'as any' cast from listDestinations, use proper DestinationType enum
- Fix baseURL to include /api/v1 prefix
- Update events.test.ts to use response.data instead of response.result.data
- Increase event test timeouts from 30s to 60s for reliability
Example Updates:
- Update all TypeScript examples to use 'params' instead of 'destinationCreate'
- Update examples/package.json to use local SDK path for development
Overlay Configuration:
- Maintain global tenant_id parameter in speakeasy-modifications-overlay.yaml
to support optional tenant_id for JWT authentication
Documentation:
- Update docs/pages/sdks.mdx to use 'params' in code examples
All tests passing (132 passing, 14 pending). SDKs verified to generate
correctly with 'params' field name. Ready for SDK generation via GitHub
Actions with set_version: for TypeScript, Python, and Go SDKs.
SDK Release Preparation for v0.12 - Enum Fix, Consistent Request Body Naming, and Migration Guide Updates
* `Outpost.Destinations.Enable()`: * `response` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Tenants.GetToken()`: * `response.TenantId` **Added** * `error` **Changed** **Breaking**⚠️ * `Outpost.Tenants.Upsert()`: * `request.Params` **Added** * `response` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Tenants.Get()`: * `response` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Tenants.Delete()`: `error` **Changed** **Breaking**⚠️ * `Outpost.Tenants.GetPortalUrl()`: * `response.TenantId` **Added** * `error` **Changed** **Breaking**⚠️ * `Outpost.Destinations.Delete()`: `error` **Changed** **Breaking**⚠️ * `Outpost.Destinations.List()`: * `request.Type` **Changed** **Breaking**⚠️ * `response.[]` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Destinations.Create()`: * `request.Params` **Changed** * `response` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Destinations.Get()`: * `response` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Health.Check()`: `response.status[200]` **Changed** **Breaking**⚠️ * `Outpost.Destinations.Update()`: * `request.Params` **Changed** * `response.[destination]` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Schemas.Get()`: `error` **Changed** **Breaking**⚠️ * `Outpost.Destinations.Disable()`: * `response` **Changed** * `error` **Changed** **Breaking**⚠️ * `Outpost.Events.Retry()`: `error` **Changed** **Breaking**⚠️ * `Outpost.Schemas.ListTenantDestinationTypes()`: `error` **Changed** **Breaking**⚠️ * `Outpost.Events.GetByDestination()`: * `response` **Changed** **Breaking**⚠️ * `error` **Changed** **Breaking**⚠️ * `Outpost.Topics.List()`: `error` **Changed** **Breaking**⚠️ * `Outpost.Events.List()`: * `response` **Changed** **Breaking**⚠️ * `error` **Changed** **Breaking**⚠️ * `Outpost.Events.Get()`: * `response` **Changed** **Breaking**⚠️ * `error` **Changed** **Breaking**⚠️ * `Outpost.Events.ListDeliveries()`: `error` **Changed** **Breaking**⚠️ * `Outpost.Events.ListByDestination()`: * `response` **Changed** **Breaking**⚠️ * `error` **Changed** **Breaking**⚠️ * `Outpost.Tenants.ListTenants()`: **Added** * `Outpost.Publish.Event()`: `response.Duplicate` **Added**
chore: 🐝 Update SDK - Generate OUTPOST-GO 0.5.0
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.4)
Can you help keep this open source service alive? 💖 Please sponsor : )