Closed jack-burridge-tp closed 5 years ago
Thanks for the pull request @jack-burridge-tp , looks great. I'll run this through my not-yet-integrated unit and integration tests and get back in a few days.
@gadams999 hide footbox
could be added to AWSCommon.puml meaning you hide the participant at the bottom by default
For example, using it in the current state:
@startuml
!define AWSPuml /Users/jack/Dev/aws-icons-for-plantuml/dist
!include AWSPuml/AWSCommon.puml
!include AWSPuml/Database/all.puml
!include AWSPuml/Compute/all.puml
hide footbox
actor User as user
LambdaParticipant(lambda,Insert lambda,adds to db)
DynamoDBParticipant(db,Stuff database,holds stuff)
user -> lambda: Invoke lambda with stuff
lambda -> db: Add stuff to database
@enduml
Would become:
If you want the footbox you just add show footbox
to your file, so it is still reversable.
I'd prefer to leave default settings as-is (show footbox by default), but document an example to show how to disable (as per yours above).
Reviewed the overall approach and looks clean, great addition to the repo! Will start a review and add some comments there.
Description of changes: Adds participant types to the generated puml, this allows you to easily draw sequence diagrams, for example:
Will become:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.