Skip to content

Commit

Permalink
First pass trying UML in metanorma
Browse files Browse the repository at this point in the history
  • Loading branch information
douglm committed Apr 23, 2024
1 parent a848783 commit 0c4e7d9
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 0 deletions.
2 changes: 2 additions & 0 deletions iTip-rewrite/sources/draft-ietf-calext-itipbis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ include::sections/00-abstract.adoc[]
//include::sections/00-foreword.adoc[]
include::sections/01-intro.adoc[]

include::sections/20-abstract-model.adoc[]

// :sectnums:

include::sections/applicationprotocolelements.adoc[]
Expand Down
5 changes: 5 additions & 0 deletions iTip-rewrite/sources/models/models/CalendarAddressType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name: CalendarAddressType
attributes:
calAdddress:
definition: Uniquely identifies the participant
type: uri
13 changes: 13 additions & 0 deletions iTip-rewrite/sources/models/models/OwnerType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: OwnerType
attributes:
sentBy:
definition: uri identify who actually sent for the owner
type: uri
cardinality:
min: 0
max: 1
relations:
- target: ParticipantType
relationship:
target:
type: inheritance
26 changes: 26 additions & 0 deletions iTip-rewrite/sources/models/models/ParticipantType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: ParticipantType
attributes:
calendarAdddress:
definition: Uniquely identifies the participant
type: CalendarAddressType
name:
type: String
role:
type: String
cardinality:
min: 1
max: "*"
dir:
description: Some form of reference to a directory
type: String
cardinality:
min: 0
max: 1
language:
description: A language code
type: String
cardinality:
min: 0
max: 1


9 changes: 9 additions & 0 deletions iTip-rewrite/sources/models/views/OwnerType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: OwnerType
title: Owner datamodel
caption: Owner datamodel
imports:
OwnerType:
ParticipantType:
CalendarAddressType:
fidelity:
hideOtherClasses: true
24 changes: 24 additions & 0 deletions iTip-rewrite/sources/sections/20-abstract-model.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[[abstract-model]]
== The Abstract Data Model

This section will describe the classes and attributes required to carry out iTip scheduling. They will be described in abstract terms defined here and later sections will describe how the model is expressed in various concrete representations.

This document will not attempt to provide a full abstract model for the calendar components, properties and parameters defined in <<RFC5545>>. Rather, only those classes and attributes that are required for iTip are described here.

=== Calendar Address
Participants in iTip scheduling are identified only by their calendar-address. The calendar-address value type is a uri, usually a mailto.

Example:: mailto:[email protected]

=== The Owner.
when an object is scheduled with iTip one party is the "Owner" (sometimes referred to as the "Organizer").

The owner (like other participants) is identified by a calendar-address. Additionally, it may have any of: a name; a reference to some form of directory entry; a language specifier.

(Do we drop sentBy?)

[datamodel]
....
include::../models/views/OwnerType.yml[]
....

0 comments on commit 0c4e7d9

Please sign in to comment.