Skip to content
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.

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

API-CLIENT: Create controllers to make request on behalf of the client apps #347

Closed
rajdip-b opened this issue Jul 11, 2024 · 4 comments
Closed
Labels
difficulty: 3 foss hack Clustering all the curated issues for Foss Hack 2024 help wanted Extra attention is needed priority: high scope: api-client type: feature Release drafter tag for tagging PRs related to adding new features

Comments

@rajdip-b
Copy link
Member

rajdip-b commented Jul 11, 2024

Description

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
  • Workspace Membership
  • 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

Objectives

@NangunooriAbhinav
Copy link

Hey, my name is Abhinav. I am one of the participants of FOSS Hack. We would like to to contribute to this issue.

@rajdip-b
Copy link
Member Author

Hey @NangunooriAbhinav! We would love that! Could you please comment /attempt on any of the sub issue(s)?

P.S. We would love to assign all of these to you but then there might be others who might also want to attempt them.

@NangunooriAbhinav
Copy link

Yea sure, i will make sure to leave a comment on a sub issue.

Me and my team will be looking forward to contributing to these issues.

@rajdip-b
Copy link
Member Author

That would be awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: 3 foss hack Clustering all the curated issues for Foss Hack 2024 help wanted Extra attention is needed priority: high scope: api-client type: feature Release drafter tag for tagging PRs related to adding new features
Projects
None yet
Development

No branches or pull requests

2 participants