API CLIENT Controllers of Keyshade.

The api-client package contains a set of controllers to make calls to the API.
Description
Issues / PRs
Team Members

The api-client package contains a set of controllers to make calls to the API. We would use these controllers from the CLI and the platform to perform all the API related operations. As a result, we would like to have all the client requests in this api-client package.

Currently, we just have the controller for Environment module, but we would like to add all the other ones aswell. Here's the list:

  • Workspace

  • User

  • Project

  • Variable

  • Secret

  • Integration

  • User

  • Workspace Role

  • Event

Solution

This is a parent issue, and all other issues linked to this would follow the same pattern. Just that the scope of implementation will vary. Here are the general pointers that should be implemented:

  • Create a controller under src/controllers and name it as <module-name>.ts.

  • Implement all the API calls from within this controller. Refer to this

  • Add the request and response types under src/types/<module-name>.types.d.ts. Refer to this

  • Add relevant tests under tests/<module-name>.spec.ts. Refer to this

Issues, PRs and Discussions
Varad Gupta
Varad Gupta
varad_gupta