feat: add delete endpoint

[psankhe28]

Description

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

Fixes #(issue)
#333

Checklist

• My code follows the contributing guidelines of this project.
• I am aware that all my commits will be squashed into a single commit, using the PR title as the commit message.
• I have performed a self-review of my own code.
• I have commented my code in hard-to-understand areas.
• I have updated the user-facing documentation to describe any new or changed behavior.
• My changes generate no new warnings.
• I have added tests that prove my fix is effective or that my feature works.
• I have not reduced the existing code coverage.

Comments

Summary by Sourcery

Introduce a new endpoint to delete DRS objects by their ID and update the documentation to reflect this new functionality.

New Features:

• Add an endpoint to delete a DRS object based on its ID.

Documentation:

• Update README.md to include documentation for the new deleteObject endpoint.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 1abf16e

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]

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 12, 2024 3:17pm

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new endpoint to delete DRS objects by their ID. The implementation includes the addition of the deleteObject function in the drsAPI.ts file, complete with error handling and JSDoc comments. Corresponding documentation updates have been made in the README.md file to describe the new endpoint and its parameters.

File-Level Changes

Files	Changes
packages/ecc-client-elixir-drs-filer/src/API/Object/drsAPI.ts packages/ecc-client-elixir-drs-filer/src/API/Object/README.md	Introduced a new deleteObject function to the DRS API and updated the documentation to reflect this new endpoint.

---

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:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @psankhe28 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider improving error handling in the deleteObject function to process the response consistently with other API functions.
• Tests for the new delete endpoint functionality are missing. Please add appropriate tests to ensure the feature works as expected.
• For consistency, consider aligning the parameter order in deleteObject with postObject (i.e., baseURL as the first parameter).

Here's what I looked at during the review

• 🟡 General issues: 3 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 1 issue found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[SalihuDickson]

@psankhe28, you can merge when you're ready