-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
structurizr.yaml
1594 lines (1553 loc) · 52.6 KB
/
structurizr.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: 1.29.0
title: Structurizr
description: The web API for Structurizr.
servers:
- url: https://api.structurizr.com
paths:
'/workspace/{id}':
get:
parameters:
- name: id
in: path
description: The workspace ID.
required: true
schema:
type: string
responses:
'200':
description: A Structurizr workspace.
content:
application/json:
schema:
$ref: "#/components/schemas/Workspace"
put:
parameters:
- name: id
in: path
description: The workspace ID.
required: true
schema:
type: string
requestBody:
description: The workspace to be stored.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Workspace'
responses:
'200':
description: Updates the workspace.
'/workspace/{id}/lock':
put:
parameters:
- name: id
in: path
description: The workspace ID.
required: true
schema:
type: string
responses:
'200':
description: An API response indicating success or failure.
content:
application/json:
schema:
$ref: "#/components/schemas/APIResponse"
delete:
parameters:
- name: id
in: path
description: The workspace ID.
required: true
schema:
type: string
responses:
'200':
description: An API response indicating success or failure.
content:
application/json:
schema:
$ref: "#/components/schemas/APIResponse"
components:
schemas:
Workspace:
type: object
description: Represents a Structurizr workspace, which is a wrapper for a software architecture model, views, and documentation.
properties:
id:
type: number
format: long
description: The workspace ID.
name:
type: string
description: The name of the workspace.
description:
type: string
description: A short description of the workspace.
version:
type: string
description: A version number for the workspace.
thumbnail:
type: string
description: The thumbnail associated with the workspace; a Base64 encoded PNG file as a data URI (data:image/png;base64).
lastModifiedDate:
type: string
description: The last modified date, in ISO 8601 format (e.g. "2018-09-08T12:40:03Z").
lastModifiedUser:
type: string
description: A string identifying the user who last modified the workspace (e.g. an e-mail address or username).
lastModifiedAgent:
type: string
description: A string identifying the agent that was last used to modify the workspace (e.g. "structurizr-java/1.2.0").
model:
$ref: '#/components/schemas/Model'
views:
$ref: '#/components/schemas/Views'
documentation:
$ref: '#/components/schemas/Documentation'
configuration:
$ref: '#/components/schemas/WorkspaceConfiguration'
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
Model:
type: object
description: A software architecture model.
properties:
enterprise:
type: object
description: The enterprise associated with this model.
properties:
name:
type: string
description: The name of the enterprise.
people:
type: array
items:
$ref: '#/components/schemas/Person'
softwareSystems:
type: array
items:
$ref: '#/components/schemas/SoftwareSystem'
deploymentNodes:
type: array
items:
$ref: '#/components/schemas/DeploymentNode'
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
Person:
type: object
description: A person who uses a software system.
properties:
id:
type: string
description: The ID of this person in the model.
name:
type: string
description: The name of this person.
description:
type: string
description: A short description of this person.
tags:
type: string
description: A comma separated list of tags associated with this person.
url:
type: string
description: The URL where more information about this element can be found.
location:
type: string
description: The location of this person.
enum:
- External
- Internal
- Unspecified
group:
type: string
description: The name of the group in which this person should be included in.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
items:
$ref: '#/components/schemas/Relationship'
description: The set of relationships from this person to other elements.
SoftwareSystem:
type: object
description: A software system.
properties:
id:
type: string
description: The ID of this software system in the model.
name:
type: string
description: The name of this software system.
description:
type: string
description: A short description of this software system.
location:
type: string
description: The location of this software system.
enum:
- External
- Internal
- Unspecified
tags:
type: string
description: A comma separated list of tags associated with this software system.
url:
type: string
description: The URL where more information about this element can be found.
containers:
type: array
description: The set of containers within this software system.
items:
$ref: '#/components/schemas/Container'
group:
type: string
description: The name of the group in which this software system should be included in.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
description: The set of relationships from this software system to other
elements.
items:
$ref: '#/components/schemas/Relationship'
documentation:
$ref: '#/components/schemas/Documentation'
Container:
type: object
description: A container (something that can execute code or host data).
properties:
id:
type: string
description: The ID of this container in the model.
name:
type: string
description: The name of this container.
description:
type: string
description: A short description of this container.
technology:
type: string
description: The technology associated with this container (e.g. Apache Tomcat).
tags:
type: string
description: A comma separated list of tags associated with this container.
url:
type: string
description: The URL where more information about this element can be found.
components:
type: array
description: The set of components within this container.
items:
$ref: '#/components/schemas/Component'
group:
type: string
description: The name of the group in which this container should be included in.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
description: The set of relationships from this container to other elements.
items:
$ref: '#/components/schemas/Relationship'
documentation:
$ref: '#/components/schemas/Documentation'
Component:
type: object
description: A component (a grouping of related functionality behind an interface that runs inside a container).
properties:
id:
type: string
description: The ID of this component in the model.
name:
type: string
description: The name of this component.
description:
type: string
description: A short description of this component.
technology:
type: string
description: The technology associated with this component (e.g. Spring Bean).
tags:
type: string
description: A comma separated list of tags associated with this component.
url:
type: string
description: The URL where more information about this element can be found.
group:
type: string
description: The name of the group in which this component should be included in.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
description: The set of relationships from this component to other elements.
items:
$ref: '#/components/schemas/Relationship'
documentation:
$ref: '#/components/schemas/Documentation'
DeploymentNode:
type: object
description: A deployment node.
properties:
id:
type: string
description: The ID of this deployment node in the model.
name:
type: string
description: The name of this deployment node.
description:
type: string
description: A short description of this deployment node.
technology:
type: string
description: The technology associated with this deployment node (e.g. Apache Tomcat).
environment:
type: string
description: The deployment environment in which this deployment node resides (e.g. "Development", "Live", etc).
instances:
type: string
description: The number of instances; either a number (e.g. 1, 2, etc) or a range (e.g. 0..N, 0..*, 1..3, etc).
tags:
type: string
description: A comma separated list of tags associated with this deployment node.
url:
type: string
description: The URL where more information about this element can be found.
children:
type: array
description: The set of child/nested deployment nodes.
items:
$ref: '#/components/schemas/DeploymentNode'
infrastructureNodes:
type: array
items:
$ref: '#/components/schemas/InfrastructureNode'
softwareSystemInstances:
type: array
description: The set of software systems instances running in this deployment node..
items:
$ref: '#/components/schemas/SoftwareSystemInstance'
containerInstances:
type: array
description: The set of container instances running in this deployment node..
items:
$ref: '#/components/schemas/ContainerInstance'
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
description: The set of relationships from this deployment node to other elements.
items:
$ref: '#/components/schemas/Relationship'
InfrastructureNode:
type: object
description: An infrastructure node.
properties:
id:
type: string
description: The ID of this infrastructure node in the model.
name:
type: string
description: The name of this infrastructure node.
description:
type: string
description: A short description of this infrastructure node.
technology:
type: string
description: The technology associated with this infrastructure node (e.g. "Route 53").
environment:
type: string
description: The deployment environment in which this infrastructure node resides (e.g. "Development", "Live", etc).
tags:
type: string
description: A comma separated list of tags associated with this infrastructure node.
url:
type: string
description: The URL where more information about this element can be found.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
description: The set of relationships from this infrastructure node to other elements.
items:
$ref: '#/components/schemas/Relationship'
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.
softwareSystemId:
type: string
description: The ID of the software system this is an instance of.
instanceId:
type: number
description: The number/index of this instance.
environment:
type: string
description: The deployment environment in which this software system instance resides (e.g. "Development", "Live", etc).
tags:
type: string
description: A comma separated list of tags associated with this software system instance.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
description: The set of relationships from this software system instance to other elements.
items:
$ref: '#/components/schemas/Relationship'
healthChecks:
type: array
description: The set of HTTP-based health checks for this software system instance.
items:
$ref: '#/components/schemas/HttpHealthCheck'
ContainerInstance:
type: object
description: An instance of a container, running on a deployment node.
properties:
id:
type: string
description: The ID of this container instance in the model.
containerId:
type: string
description: The ID of the container this is an instance of.
instanceId:
type: number
description: The number/index of this instance.
environment:
type: string
description: The deployment environment in which this container instance resides (e.g. "Development", "Live", etc).
tags:
type: string
description: A comma separated list of tags associated with this container instance.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this element.
relationships:
type: array
description: The set of relationships from this container instance to other elements.
items:
$ref: '#/components/schemas/Relationship'
healthChecks:
type: array
description: The set of HTTP-based health checks for this container instance.
items:
$ref: '#/components/schemas/HttpHealthCheck'
HttpHealthCheck:
type: object
description: Describes a HTTP based health check.
properties:
name:
type: string
description: The name of the health check.
url:
type: string
description: The health check URL/endpoint.
interval:
type: number
format: integer
description: The polling interval, in seconds.
timeout:
type: number
format: integer
description: The timeout after which a health check is deemed as failed, in milliseconds.
headers:
type: object
description: A set of name-value pairs corresponding to HTTP headers that should be sent with the request.
additionalProperties: true
Relationship:
type: object
description: A relationship between two elements.
properties:
id:
type: string
description: The ID of this relationship in the model.
description:
type: string
description: A short description of this relationship.
tags:
type: string
description: A comma separated list of tags associated with this relationship.
url:
type: string
description: The URL where more information about this relationship can be found.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
perspectives:
type: array
items:
$ref: '#/components/schemas/Perspective'
description: The set of perspectives associated with this relationship.
sourceId:
type: string
description: The ID of the source element.
destinationId:
type: string
description: The ID of the destination element.
technology:
type: string
description: The technology associated with this relationship (e.g. HTTPS, JDBC, etc).
interactionStyle:
type: string
description: The interaction style (synchronous or asynchronous).
enum:
- Synchronous
- Asynchronous
linkedRelationshipId:
type: string
description: The ID of the container-container relationship upon which this container instance-container instance relationship is based.
Perspective:
type: object
description: Represents an architectural perspective, that can be applied to elements and relationships.
properties:
name:
type: string
description: The name of this perspective (e.g. "Security").
description:
type: string
description: The description of this perspective.
value:
type: string
description: The value of this perspective (optional).
Views:
type: object
description: The set of views onto a software architecture model.
properties:
systemLandscapeViews:
type: array
description: The set of system landscape views.
items:
$ref: '#/components/schemas/SystemLandscapeView'
systemContextViews:
type: array
description: The set of system context views.
items:
$ref: '#/components/schemas/SystemContextView'
containerViews:
type: array
description: The set of container views.
items:
$ref: '#/components/schemas/ContainerView'
componentViews:
type: array
description: The set of component views.
items:
$ref: '#/components/schemas/ComponentView'
dynamicViews:
type: array
description: The set of dynamic views.
items:
$ref: '#/components/schemas/DynamicView'
deploymentViews:
type: array
description: The set of deployment views.
items:
$ref: '#/components/schemas/DeploymentView'
filteredViews:
type: array
description: The set of filtered views.
items:
$ref: '#/components/schemas/FilteredView'
imageViews:
type: array
description: The set of image views.
items:
$ref: '#/components/schemas/ImageView'
configuration:
$ref: '#/components/schemas/Configuration'
SystemLandscapeView:
type: object
description: A system landscape view.
properties:
key:
type: string
description: A unique identifier for this view.
order:
type: number
description: An integer representing the creation order of this view.
title:
type: string
description: The title of this view (optional).
description:
type: string
description: The description of this view.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
paperSize:
type: string
description: The paper size that should be used to render this view.
enum:
- A6_Portrait
- A6_Landscape
- A5_Portrait
- A5_Landscape
- A4_Portrait
- A4_Landscape
- A3_Portrait
- A3_Landscape
- A2_Portrait
- A2_Landscape
- A1_Portrait
- A1_Landscape
- A0_Portrait
- A0_Landscape
- Letter_Portrait
- Letter_Landscape
- Legal_Portrait
- Legal_Landscape
- Slide_4_3
- Slide_16_9
- Slide_16_10
dimensions:
$ref: '#/components/schemas/Dimensions'
automaticLayout:
$ref: '#/components/schemas/AutomaticLayout'
enterpriseBoundaryVisible:
type: boolean
description: Specifies whether the enterprise boundary (to differentiate internal elements from external elements) should be visible on the resulting diagram.
elements:
type: array
description: The set of elements in this views.
items:
$ref: '#/components/schemas/ElementView'
relationships:
type: array
description: The set of relationships in this views.
items:
$ref: '#/components/schemas/RelationshipView'
animations:
type: array
description: The set of animation steps (optional).
items:
$ref: '#/components/schemas/AnimationStep'
SystemContextView:
type: object
description: A system context view.
properties:
key:
type: string
description: A unique identifier for this view.
order:
type: number
description: An integer representing the creation order of this view.
title:
type: string
description: The title of this view (optional).
description:
type: string
description: The description of this view.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
softwareSystemId:
type: string
description: The ID of the software system this view is associated with.
paperSize:
type: string
description: The paper size that should be used to render this view.
enum:
- A6_Portrait
- A6_Landscape
- A5_Portrait
- A5_Landscape
- A4_Portrait
- A4_Landscape
- A3_Portrait
- A3_Landscape
- A2_Portrait
- A2_Landscape
- A1_Portrait
- A1_Landscape
- A0_Portrait
- A0_Landscape
- Letter_Portrait
- Letter_Landscape
- Legal_Portrait
- Legal_Landscape
- Slide_4_3
- Slide_16_9
- Slide_16_10
dimensions:
$ref: '#/components/schemas/Dimensions'
automaticLayout:
$ref: '#/components/schemas/AutomaticLayout'
enterpriseBoundaryVisible:
type: boolean
description: Specifies whether the enterprise boundary (to differentiate internal elements from external elements") should be visible on the resulting diagram.
elements:
type: array
description: The set of elements in this view.
items:
$ref: '#/components/schemas/ElementView'
relationships:
type: array
description: The set of relationships in this view.
items:
$ref: '#/components/schemas/RelationshipView'
animations:
type: array
description: The set of animation steps (optional).
items:
$ref: '#/components/schemas/AnimationStep'
ContainerView:
type: object
description: A container view.
properties:
key:
type: string
description: A unique identifier for this view.
order:
type: number
description: An integer representing the creation order of this view.
title:
type: string
description: The title of this view (optional).
description:
type: string
description: The description of this view.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
softwareSystemId:
type: string
description: The ID of the software system this view is associated with.
paperSize:
type: string
description: The paper size that should be used to render this view.
enum:
- A6_Portrait
- A6_Landscape
- A5_Portrait
- A5_Landscape
- A4_Portrait
- A4_Landscape
- A3_Portrait
- A3_Landscape
- A2_Portrait
- A2_Landscape
- A1_Portrait
- A1_Landscape
- A0_Portrait
- A0_Landscape
- Letter_Portrait
- Letter_Landscape
- Legal_Portrait
- Legal_Landscape
- Slide_4_3
- Slide_16_9
- Slide_16_10
dimensions:
$ref: '#/components/schemas/Dimensions'
automaticLayout:
$ref: '#/components/schemas/AutomaticLayout'
elements:
type: array
description: The set of elements in this views.
items:
$ref: '#/components/schemas/ElementView'
relationships:
type: array
description: The set of relationships in this views.
items:
$ref: '#/components/schemas/RelationshipView'
animations:
type: array
description: The set of animation steps (optional).
items:
$ref: '#/components/schemas/AnimationStep'
externalSoftwareSystemBoundariesVisible:
type: boolean
description: Specifies whether software system boundaries should be visible for "external" containers (those outside the software system in scope).
ComponentView:
type: object
description: A component view.
properties:
key:
type: string
description: A unique identifier for this view.
order:
type: number
description: An integer representing the creation order of this view.
title:
type: string
description: The title of this view (optional).
description:
type: string
description: The description of this view.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
containerId:
type: string
description: The ID of the container this view is associated with.
paperSize:
type: string
description: The paper size that should be used to render this view.
enum:
- A6_Portrait
- A6_Landscape
- A5_Portrait
- A5_Landscape
- A4_Portrait
- A4_Landscape
- A3_Portrait
- A3_Landscape
- A2_Portrait
- A2_Landscape
- A1_Portrait
- A1_Landscape
- A0_Portrait
- A0_Landscape
- Letter_Portrait
- Letter_Landscape
- Legal_Portrait
- Legal_Landscape
- Slide_4_3
- Slide_16_9
- Slide_16_10
dimensions:
$ref: '#/components/schemas/Dimensions'
automaticLayout:
$ref: '#/components/schemas/AutomaticLayout'
elements:
type: array
description: The set of elements in this views.
items:
$ref: '#/components/schemas/ElementView'
relationships:
type: array
description: The set of relationships in this views.
items:
$ref: '#/components/schemas/RelationshipView'
animations:
type: array
description: The set of animation steps (optional).
items:
$ref: '#/components/schemas/AnimationStep'
externalContainerBoundariesVisible:
type: boolean
description: Specifies whether container boundaries should be visible for "external" components (those outside the container in scope).
DynamicView:
type: object
description: A dynamic view.
properties:
key:
type: string
description: A unique identifier for this view.
order:
type: number
description: An integer representing the creation order of this view.
title:
type: string
description: The title of this view (optional).
description:
type: string
description: The description of this view.
properties:
type: object
description: A set of arbitrary name-value properties.
additionalProperties: true
elementId:
type: string
description: The ID of the element this view is associated with (optional).
paperSize:
type: string
description: The paper size that should be used to render this view.
enum:
- A6_Portrait
- A6_Landscape
- A5_Portrait
- A5_Landscape
- A4_Portrait
- A4_Landscape
- A3_Portrait
- A3_Landscape
- A2_Portrait
- A2_Landscape
- A1_Portrait
- A1_Landscape
- A0_Portrait
- A0_Landscape
- Letter_Portrait
- Letter_Landscape
- Legal_Portrait
- Legal_Landscape
- Slide_4_3
- Slide_16_9
- Slide_16_10
dimensions:
$ref: '#/components/schemas/Dimensions'
automaticLayout:
$ref: '#/components/schemas/AutomaticLayout'
elements:
type: array
description: The set of elements in this views.
items:
$ref: '#/components/schemas/ElementView'
relationships:
type: array
description: The set of relationships in this views.
items:
$ref: '#/components/schemas/RelationshipView'
externalBoundariesVisible:
type: boolean
description: Specifies software system/container boundaries should be visible for "external" containers/components (those outside the element in scope)
DeploymentView:
type: object
description: A deployment view.
properties:
key:
type: string
description: A unique identifier for this view.
order:
type: number
description: An integer representing the creation order of this view.
title:
type: string
description: The title of this view (optional).