elixir-cloud-aai / cloud-components

Reusable components for the ELIXIR Cloud
https://cloud-components.2.rahtiapp.fi/
Apache License 2.0
8 stars 14 forks source link

feat: add delete endpoint (#345) #346

Open psankhe28 opened 3 months ago

psankhe28 commented 3 months ago

Description

It adds an endpoint to delete the drs object based on the object id

Fixes #(issue)

333

Checklist

Comments

Summary by Sourcery

Add a delete endpoint to the API for removing DRS objects by ID and update the documentation to reflect this new functionality.

New Features:

Documentation:

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 7b0a6b87ac809bccafbff822240a899c8bb2cea9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
elixir-cloud-components ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 13, 2024 7:38pm
sourcery-ai[bot] commented 3 months ago

Reviewer's Guide by Sourcery

This pull request implements a new endpoint to delete DRS objects by their ID. The changes include adding a new deleteObject function in the drsAPI.ts file and updating the README.md to document this new functionality. The implementation follows RESTful principles and includes error handling.

File-Level Changes

Files Changes
packages/ecc-client-elixir-drs-filer/src/API/Object/drsAPI.ts Implemented a new deleteObject function to handle DELETE requests for DRS objects
packages/ecc-client-elixir-drs-filer/src/API/Object/drsAPI.ts Added JSDoc comments to explain the postObject and deleteObject functions
packages/ecc-client-elixir-drs-filer/src/API/Object/drsAPI.ts Updated the export statement to include the new deleteObject function
packages/ecc-client-elixir-drs-filer/src/API/Object/README.md Added documentation for the new deleteObject endpoint in the README

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
SalihuDickson commented 3 months ago

@psankhe28, please address the request changes and resolve conflicts with main so I can re-review.

anuragxxd commented 3 days ago

Hey @psankhe28, can we have this merged?