sphinx-needs icon indicating copy to clipboard operation
sphinx-needs copied to clipboard

needs.json schema? How are links stored?

Open arwedus opened this issue 11 months ago • 1 comments

Is it currently correct to store custom link options of a need flat, e.g.

                "ACTIVITY_ThisAndThat": {
                    "description": "",
                    "id": "ACTIVITY_ThisAndThat",
                    "implements": [],
                    "has_in_port": ["...", ...],
                    "has_out_port": ["...", ...],
                    "instantiates": ["...", ...]
                 },

or nested below "links", like this:

                "ACTIVITY_ThisAndThat": {
                    "description": "",
                    "id": "ACTIVITY_ThisAndThat",
                    "implements": [],
                    "links": {
                        "has_in_port": "...,...",
                        "has_out_port": "...",
                        "instantiates": "...",
                    },
                }

I could not find anything in the docs. I'm writing a needs.json generator right now, so I needs to know :laughing:

arwedus avatar Mar 15 '24 15:03 arwedus

The first one is correct, so it's just a "flat" dictionary.

danwos avatar Mar 19 '24 07:03 danwos

I think this can be closed with #1230

chrisjsewell avatar Sep 02 '24 08:09 chrisjsewell