Changing the OpenAPI Tool sanitize Sub Command Name - bal openapi sanitize

[SachinAkash01]

Description

The following are few suggestions:

1. bal openapi conform - Implies ensuring the contract conforms to Ballerina-friendly standards
2. bal openapi adapt - Implies adapting the OpenAPI contract to fit Ballerina's requirements
3. bal openapi align - Emphasises aligning the OpenAPI contract with Ballerina's best practices
4. bal openapi transform - Indicates transforming the OpenAPI contract to be compatible with Ballerina

Version

No response

[lnash94]

How about using bal openapi adapt as a subcommand? Since our primary goal is to modify the specification so that it aligns with Ballerina.
I’d reserve “transform” for cases where we’re converting between formats (for example, OpenAPI v3 to OpenAPI v2, or OpenAPI to a API Blueprint model, RAML).

[SachinAkash01]

Meeting : 06/01/2025

Attendees: @shafreenAnfar @daneshk @lnash94 @TharmiganK @SachinAkash01

Notes:

• As discussed, we have decided to replace the bal openapi sanitize sub-command with bal openapi align, as the term align better reflects the purpose of this command.
• The bal openapi align command will take an OpenAPI specification as input, modify it to align with Ballerina's best practices (eg: adhering to naming conventions), and output a modified OpenAPI specification.
• The output file currently named as sanitized_openapi.json will be renamed to aligned_ballerina_openapi.json to maintain the consistency within the new sub-command and its intent.