microcks / microcks/microcks-cli

Feature Request: Add `delete` command to CLI to remove APIs from Microcks

Open
#294 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component/cli go kind/feature
Dominant language
Go
Stars
52
Forks
68
Avg merge
6h 54m
Merged PRs (30d)
10

Description

## Description :
Currently, the Microcks CLI allows users to `import` and `test` APIs, but there is no native way to delete an API directly from the command line. This makes it difficult to maintain clean environments, especially in CI/CD pipelines where we often want to clean up older, unused iterations of an API or tear down temporary mock services.

## Describe the solution you'd like
I would like to see a new `microcks delete` command added to the CLI.

The command should:
- Take the API name and version as a single argument (e.g., ``).
- Look up the internal service ID using the Microcks REST API.
- Safely delete the target service.
- Return a clear success or failure message.

**Proposed Usage:**
`microcks delete "MyService:1.0"`

## Describe alternatives you've considered
The only current alternative is to manually write `curl` scripts to first query the `/api/services/search` endpoint to find the system `id` and then issue a `DELETE` request, or to manage deletions manually through the Web UI. Having this integrated into the CLI is much cleaner.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing CLI commands and the Microcks REST API usage, then inspect the /api/services/search endpoint behavior. Done means `microcks delete "MyService:1.0"` resolves the service and removes it safely, with clear success or failure output; verify the command against a temporary service and relevant CLI tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.