CLI: Add request and response validation

[rajdip-b]

Description

The CLI currently uses no validation at all. We would like the cli to use schema package to add validation to its modules. This will include input (request) and output (response) validation. The idea is, before making an API call, we would like to inspect the request body with the request schema. If it passes, we make the call. Similarly, when we get back a response from the API, we match the response with the response schema and print only those fields that matches the response type.

Solution

We would like to implement these changes across the following modules. The changes would include updating each and every command of every module to include validation.

• Workspace
• Workspace Role
• Workspace Membership
• Project
• Environment
• Secret
• Variable
• Integration
• Event

[yetanotheraryan]

Hi @rajdip-b, Let me just clarify the problem statement here, we want to put in request and response schema for validations for all the API's in the mentioned modules list right? using any validation library like Joi for example?

Looking forward to contribute on the same.

[rajdip-b]

Hey, all the validation is already set up in schema package. You can find it under packages/schema folder. You would need to import the schemas from the schema package one by one (for every module) and then validate the request and responses in the CLI app you can find under apps/cli. Hope that helps.

You can also refer how packages/api-client uses the schema package.

[vr-varad]

hey @rajdip-b I would like to work on this issue if its open for contribution

[rajdip-b]

if @yetanotheraryan is not attempting it, then yes.

[vr-varad]

hey @yetanotheraryan are u working on this issue