web-api/docs/architecture/specification.c4 at main · OpenHomeFoundation/web-api · GitHub

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
// Shared vocabulary for every diagram in this model: element kinds, the
// relationship kinds that carry protocol/technology, and the tags views filter
// on. Defined once here so a "container" or an "external system" reads the same
// wherever it appears.
specification {
  element actor {
    notation 'Person'
    style {
      shape person
      color secondary
    }
  }

  element system {
    notation 'Software system'
  }

  // Anything the foundation does not run as part of this service.
  element external {
    notation 'External system'
    style {
      color muted
    }
  }

  element container {
    notation 'Container'
  }

  element component {
    notation 'Component'
  }

  element store {
    notation 'Data store'
    style {
      shape storage
    }
  }

  relationship https {
    technology 'HTTPS'
  }

  relationship rest {
    technology 'REST/JSON over HTTPS'
  }

  relationship atom {
    technology 'Atom XML over HTTPS'
  }

  relationship ical {
    technology 'iCalendar over HTTPS'
  }

  relationship api {
    technology 'HTTPS/JSON'
  }

  // Everything inside the one Node process: a plain method call, not a network
  // hop. Drawn dashed so the boundary between the two is visible at a glance.
  relationship inproc {
    technology 'In-process call'
    line dashed
  }

  // Left over from the project template. Kept in the model rather than tidied
  // out of the picture, because it is deployed and reachable.
  tag scaffolding
}