microsoft / microsoft/fabric-cli

[FEATURE] Enhance output in Json format

Open
#144 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
173
Forks
63
Avg merge
2d 19h
Merged PRs (30d)
4

Description

Use Case / Problem

Including API response or command details in a JSON output can make results clearer and more useful for both users and automation.

Proposed Solution

Place the API result or command details inside the result.data object for easy access and better integration.

Alternatives Considered

No response

Impact Assessment
  • This would help me personally
  • This would help my team/organization
  • This would help the broader fabric-cli community
  • This aligns with Microsoft Fabric roadmap items
Implementation Attestation
  • I understand this feature should maintain backward compatibility with existing commands
  • I confirm this feature request does not introduce performance regressions for existing workflows
  • I acknowledge that new features must follow fabric-cli's established patterns and conventions
Implementation Notes

This is already supported in the create command, and it should work in the others too.

For example, in the exists command, putting the result in the response instead of the message would make it easier for users to parse the value.

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 comparing the existing JSON output for the create command with the exists command, then trace the corresponding command output paths. Identify the other commands that expose API results or command details and confirm their current response shape. Done means those details are consistently available under result.data while existing command behavior remains backward compatible.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.