openfga / openfga/cli

Preserving comments from DSL when converting model to JSON

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

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
102
Forks
49
Avg merge
1d 1h
Merged PRs (30d)
16

Description

When transforming the model file to json, add a way to get the comments as well.

type org
    relations
        // Read settings of a github organizations
        define read-settings: [user]

to

    {
        "computedUserset": {
            "doc": "Read settings of a github organizations"
            "relation":"read-settings"
        }
    },

This will be super helpful.

https://cloud-native.slack.com/archives/C06G1NNH47N/p1750694123109859

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 with the CLI entry point for transforming an authorization model to JSON, linked in the issue, and trace how the DSL model is converted. Confirm how comments are represented and preserved, then verify that the example comment appears as the computed userset's doc field in the generated JSON.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.