flaviostutz / flaviostutz/cdk-practical-constructs

WSO2 redeployment should not be triggered if nothing changed in the API definition

Open
#32 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
7
Forks
7
PR merge metrics
No merged PRs in 30d

Description

## Problem being solved

WSO2 redeployment should not be triggered if nothing changed in the API definition (OpenAPI document, API configuration/properties, etc).

This would:
- Save deployment time as if there is nothing to change the custom resource will not run longer than it needs.
- Make deployments safer as even small changes can cause WSO2 to be out of sync across its instances (i.e. when changing the `properties` attribute)

## Proposal

Have some sort of "state" to be checked before trying to update an API.
Example: a checksum of the OpenAPI document, etc. of a previously succeeded deployment. If still the same, then there is nothing to do.

Contributor guide

Open the contributing guide

Research direction

Start by locating the WSO2 API deployment or update entry point in the repository and read how the OpenAPI document and API configuration are passed to it. Determine what previously successful deployment state is available and how changes are detected. Done means unchanged definitions skip redeployment while changed definitions still trigger it, with coverage for both cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.