Sequence generation

To generate a sample sequence diagram you will need a rediOps (devops.json) file. Open a terminal window in a project folder that has a rediOps file, and execute the command qaskx-cli rediops sequence -o ^/docs/sequence01.md.

The command will find the rediOps file in the .well-known folder and extract the linked OpenAPI/AsyncAPI definition, the dependency definitions, and then generate the sequence diagram named sequence01.md in the docs folder at the root of the project.

Details

The command will look for the .well-known folder and locate the rediOps file in that folder. If the rediOps is elsewhere then you will need to use the –devops argument.

You can specify an output file with the –output argument and if the file already exists, you can specify the –overwrite argument.

The prefix “:/” for the –output argument file name indicates the root of the project folder. The special prefix “~/” is also understand as the home directory.