structurizr / json Goto Github PK

Description

Not a big deal, but as far as I can tell from the OpenAPI spec documentation, some of the number types are incorrectly described in the structurizr spec.

https://swagger.io/docs/specification/data-models/data-types/#numbers

Basically, any occurrence of

type: number
format: integer

should just be

type: integer

and any occurrence of

type: number
format: long

should be

type: integer
format: in64

Steps to reproduce

Search the OpenAPI spec for format: long or format: integer.

Screenshot

No response

Code sample

No response

Configuration

No response

Severity

Minor

Priority

I have no budget and there's no rush, please fix this for free

More information

No response

Hi @simonbrowndotje and first of all thanks for all your effort with Diagrams as code & the C4 model.

I recognized while converting the DSL to JSON, the definition of "include *" in the views of the DSL files gets transformed as "real includes" in the JSON file. Can we somehow preserve this "include *" in the JSON schema, so we don't lose this information?

Thanks,
Dominik

Hey Simon, I just did see the attribute "default tags" in the JSON generated by structurizr/lite. Is this maybe missing in the OpenAPI document and how does this attribute behave? Thanks, Dominik

Description

When using tooling to generate TypeScript types, it makes every field optional, as there are no fields marked as required.

Priority

I have no budget and there's no rush, please add this feature for free

More information

No response

Description

As discussed on Slack, the new feature that allows assigning values to perspectives, is not documented in the workspace API. In fact, I can't find any mention of perspectives at all.

Since https://github.com/Midnighter/structurizr-python/ is basically a thin client around the workspace API, it will be very interesting to have perspectives in the OpenAPI spec.

Steps to reproduce

Search https://github.com/structurizr/json/blob/master/structurizr.yaml for perspectives.

Screenshot

No response

Code sample

No response

Configuration

No response

Severity

Minor

Priority

I have no budget and there's no rush, please fix this for free

More information

No response

Currently in structurizr.yaml, SoftwareSystemInstance is defined (line 421 onwards) as:

SoftwareSystemInstance:
      type: object
      description: An instance of a software system, running on a deployment node.
      properties:
        id:
          type: string
          description: The ID of this software system instance in the model.
        containerId:
          type: string
          description: The ID of the software system this is an instance of.
        instanceId:
          type: number
          description: The number/index of this instance.
        ....

I would have thought that the containerId property should actually be softwareSystemId.

I'm trying to programmatically parse c4 json to its equivalent dsl, and I can see that functionality already exists on https://structurizr.com/json, so can you please point me in the right direction on how that is implemented and possibly share the library that is used on https://structurizr.com/json to do the conversion.

Hi @simonbrowndotje, would it be possible to get a JSON example here to match groups.dsl?

Description

Contrary to the specification in structurizr.yaml, the id of a workspace is saved as a number instead of a string in the JSON file.

Steps to reproduce

1. Take the Getting Started example workspace.dsl
2. Give the workspace a name, e..g. workspace "Getting Started"
3. Open the workspace in structurizr/lite
4. Open the generated workspace.json
5. Line 5 now reads: "id": 1, and should be "id": "1",

Screenshot

No response

Code sample

No response

Configuration

No response

Severity

Minor

Priority

I have no budget and there's no rush, please fix this for free

More information

No response