Skip to content

fix(openapi): add type discriminator to DestinationUpdate union #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leggetter merged 1 commit into from
May 28, 2026
Merged

fix(openapi): add type discriminator to DestinationUpdate union #920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
301 changes: 284 additions & 17 deletions docs/apis/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions spec-sdk-tests/tests/destinations/aws-kinesis.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ describe('AWS Kinesis Destinations - Contract Tests (SDK-based validation)', ()
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

Expand Down Expand Up @@ -321,12 +321,13 @@ describe('AWS Kinesis Destinations - Contract Tests (SDK-based validation)', ()
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

it('should update destination topics', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_kinesis',
topics: ['user.created', 'user.updated'],
});

Expand All @@ -341,6 +342,7 @@ describe('AWS Kinesis Destinations - Contract Tests (SDK-based validation)', ()
// See TEST_STATUS.md for detailed analysis
it.skip('should update destination config', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_kinesis',
config: {
streamName: 'updated-stream',
},
Expand All @@ -355,6 +357,7 @@ describe('AWS Kinesis Destinations - Contract Tests (SDK-based validation)', ()

it('should update destination credentials', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_kinesis',
credentials: {
key: 'AKIAIOSFODNN7UPDATED',
secret: 'updatedSecretKey',
Expand All @@ -368,6 +371,7 @@ describe('AWS Kinesis Destinations - Contract Tests (SDK-based validation)', ()
let errorThrown = false;
try {
await client.updateDestination('non-existent-id-12345', {
type: 'aws_kinesis',
topics: ['test'],
});
} catch (error: any) {
Expand Down
8 changes: 6 additions & 2 deletions spec-sdk-tests/tests/destinations/aws-s3.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ describe('AWS S3 Destinations - Contract Tests (SDK-based validation)', () => {
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

Expand Down Expand Up @@ -321,12 +321,13 @@ describe('AWS S3 Destinations - Contract Tests (SDK-based validation)', () => {
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

it('should update destination topics', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_s3',
topics: ['user.created', 'user.updated'],
});

Expand All @@ -338,6 +339,7 @@ describe('AWS S3 Destinations - Contract Tests (SDK-based validation)', () => {

it('should update destination config', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_s3',
config: {
bucket: 'updated-bucket',
},
Expand All @@ -352,6 +354,7 @@ describe('AWS S3 Destinations - Contract Tests (SDK-based validation)', () => {

it('should update destination credentials', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_s3',
credentials: {
key: 'AKIAIOSFODNN7UPDATED',
secret: 'updatedSecretKey',
Expand All @@ -365,6 +368,7 @@ describe('AWS S3 Destinations - Contract Tests (SDK-based validation)', () => {
let errorThrown = false;
try {
await client.updateDestination('non-existent-id-12345', {
type: 'aws_s3',
topics: ['test'],
});
} catch (error: any) {
Expand Down
8 changes: 6 additions & 2 deletions spec-sdk-tests/tests/destinations/aws-sqs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ describe('AWS SQS Destinations - Contract Tests (SDK-based validation)', () => {
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

Expand Down Expand Up @@ -286,12 +286,13 @@ describe('AWS SQS Destinations - Contract Tests (SDK-based validation)', () => {
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

it('should update destination topics', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_sqs',
topics: ['user.created', 'user.updated'],
});

Expand All @@ -303,6 +304,7 @@ describe('AWS SQS Destinations - Contract Tests (SDK-based validation)', () => {

it('should update destination config', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_sqs',
config: {
queueUrl: 'https://sqs.us-west-2.amazonaws.com/123456789012/updated-queue',
},
Expand All @@ -319,6 +321,7 @@ describe('AWS SQS Destinations - Contract Tests (SDK-based validation)', () => {

it('should update destination credentials', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'aws_sqs',
credentials: {
key: 'AKIAIOSFODNN7UPDATED',
secret: 'updatedSecretKey',
Expand All @@ -332,6 +335,7 @@ describe('AWS SQS Destinations - Contract Tests (SDK-based validation)', () => {
let errorThrown = false;
try {
await client.updateDestination('non-existent-id-12345', {
type: 'aws_sqs',
topics: ['test'],
});
} catch (error: any) {
Expand Down
8 changes: 6 additions & 2 deletions spec-sdk-tests/tests/destinations/azure-servicebus.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ describe('Azure Service Bus Destinations - Contract Tests (SDK-based validation)
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

Expand Down Expand Up @@ -286,12 +286,13 @@ describe('Azure Service Bus Destinations - Contract Tests (SDK-based validation)
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

it('should update destination topics', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'azure_servicebus',
topics: ['user.created', 'user.updated'],
});

Expand All @@ -303,6 +304,7 @@ describe('Azure Service Bus Destinations - Contract Tests (SDK-based validation)

it('should update destination config', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'azure_servicebus',
config: {
name: 'updated-queue',
},
Expand All @@ -317,6 +319,7 @@ describe('Azure Service Bus Destinations - Contract Tests (SDK-based validation)

it('should update destination credentials', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'azure_servicebus',
credentials: {
connectionString:
'Endpoint=sb://updated.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=updatedkey',
Expand All @@ -330,6 +333,7 @@ describe('Azure Service Bus Destinations - Contract Tests (SDK-based validation)
let errorThrown = false;
try {
await client.updateDestination('non-existent-id-12345', {
type: 'azure_servicebus',
topics: ['test'],
});
} catch (error: any) {
Expand Down
9 changes: 7 additions & 2 deletions spec-sdk-tests/tests/destinations/gcp-pubsub.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ describe('GCP Pub/Sub Destinations - Contract Tests (SDK-based validation)', ()
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

Expand Down Expand Up @@ -458,12 +458,13 @@ describe('GCP Pub/Sub Destinations - Contract Tests (SDK-based validation)', ()
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

it('should update destination topics', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'gcp_pubsub',
topics: ['user.created', 'user.updated'],
});

Expand All @@ -475,6 +476,7 @@ describe('GCP Pub/Sub Destinations - Contract Tests (SDK-based validation)', ()

it('should update destination config', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'gcp_pubsub',
config: {
topic: 'updated-topic-name',
},
Expand All @@ -489,6 +491,7 @@ describe('GCP Pub/Sub Destinations - Contract Tests (SDK-based validation)', ()

it('should update destination credentials', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'gcp_pubsub',
credentials: {
serviceAccountJson: '{"type":"service_account","projectId":"updated"}',
},
Expand All @@ -501,6 +504,7 @@ describe('GCP Pub/Sub Destinations - Contract Tests (SDK-based validation)', ()
let errorThrown = false;
try {
await client.updateDestination('non-existent-id-12345', {
type: 'gcp_pubsub',
topics: '*',
});
} catch (error: any) {
Expand All @@ -522,6 +526,7 @@ describe('GCP Pub/Sub Destinations - Contract Tests (SDK-based validation)', ()
let errorThrown = false;
try {
await client.updateDestination(destinationId, {
type: 'gcp_pubsub',
config: {
// Missing required fields
},
Expand Down
7 changes: 5 additions & 2 deletions spec-sdk-tests/tests/destinations/hookdeck.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ describe('Hookdeck Destinations - Contract Tests (SDK-based validation)', () =>
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

Expand Down Expand Up @@ -250,12 +250,13 @@ describe('Hookdeck Destinations - Contract Tests (SDK-based validation)', () =>
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

it('should update destination topics', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'hookdeck',
topics: ['user.created', 'user.updated'],
});

Expand All @@ -267,6 +268,7 @@ describe('Hookdeck Destinations - Contract Tests (SDK-based validation)', () =>

it('should update destination credentials', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'hookdeck',
credentials: {
token: 'hk_updated_token',
},
Expand All @@ -279,6 +281,7 @@ describe('Hookdeck Destinations - Contract Tests (SDK-based validation)', () =>
let errorThrown = false;
try {
await client.updateDestination('non-existent-id-12345', {
type: 'hookdeck',
topics: ['test'],
});
} catch (error: any) {
Expand Down
8 changes: 6 additions & 2 deletions spec-sdk-tests/tests/destinations/rabbitmq.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ describe('RabbitMQ Destinations - Contract Tests (SDK-based validation)', () =>
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

Expand Down Expand Up @@ -321,12 +321,13 @@ describe('RabbitMQ Destinations - Contract Tests (SDK-based validation)', () =>
try {
await client.deleteDestination(destinationId);
} catch (error) {
console.warn('Failed to cleanup destination:', error);
console.warn('Failed to cleanup destination:', error instanceof Error ? error.message : String(error));
}
});

it('should update destination topics', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'rabbitmq',
topics: ['user.created', 'user.updated'],
});

Expand All @@ -338,6 +339,7 @@ describe('RabbitMQ Destinations - Contract Tests (SDK-based validation)', () =>

it('should update destination config', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'rabbitmq',
config: {
exchange: 'updated-exchange',
},
Expand All @@ -352,6 +354,7 @@ describe('RabbitMQ Destinations - Contract Tests (SDK-based validation)', () =>

it('should update destination credentials', async () => {
const updated = await client.updateDestination(destinationId, {
type: 'rabbitmq',
credentials: {
username: 'newuser',
password: 'newpass',
Expand All @@ -365,6 +368,7 @@ describe('RabbitMQ Destinations - Contract Tests (SDK-based validation)', () =>
let errorThrown = false;
try {
await client.updateDestination('non-existent-id-12345', {
type: 'rabbitmq',
topics: ['test'],
});
} catch (error: any) {
Expand Down
Loading
Loading