summaryrefslogtreecommitdiff
path: root/spec/spec/spec.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-18 10:20:58 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commitb9f3aa7a96c5ae96fb52f3420dbae63a99eb4e08 (patch)
tree214b6bba8c0ad9f12b108e05380bb8e0d4910e64 /spec/spec/spec.yml
parent1a363799ff1cfad049520634cd8c2230c4c574cd (diff)
spec: Add specification of specification items
Diffstat (limited to 'spec/spec/spec.yml')
-rw-r--r--spec/spec/spec.yml74
1 files changed, 74 insertions, 0 deletions
diff --git a/spec/spec/spec.yml b/spec/spec/spec.yml
new file mode 100644
index 00000000..7f33c78a
--- /dev/null
+++ b/spec/spec/spec.yml
@@ -0,0 +1,74 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+links:
+- role: spec-member
+ uid: root
+- role: spec-refinement
+ spec-key: type
+ spec-value: spec
+ uid: root
+spec-description: null
+spec-example: |
+ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+ copyrights:
+ - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ enabled-by: true
+ links:
+ - role: spec-member
+ uid: root
+ - role: spec-refinement
+ spec-key: type
+ spec-value: example
+ uid: root
+ spec-description: null
+ spec-example: null
+ spec-info:
+ dict:
+ attributes:
+ an-example-attribute:
+ description: |
+ This mandatory attribute shall be an example.
+ spec-type: optional-str
+ example-number:
+ description: |
+ This mandatory attribute shall be the example number.
+ spec-type: int
+ description: |
+ This set of attributes gives an example.
+ required-attributes: all
+ spec-name: Example Item Type
+ spec-type: spec
+ type: spec
+spec-info:
+ dict:
+ attributes:
+ spec-description:
+ description: |
+ This mandatory attribute shall be the description of the
+ specification type.
+ spec-type: optional-str
+ spec-example:
+ description: |
+ This mandatory attribute shall an example of the specification type.
+ spec-type: optional-str
+ spec-info:
+ description: |
+ This mandatory attribute defines the specification type information.
+ spec-type: spec-info
+ spec-name:
+ description: |
+ This mandatory attribute shall be the human readable name of the
+ specification type.
+ spec-type: optional-str
+ spec-type:
+ description: |
+ This mandatory attribute defines the specification type name.
+ spec-type: name
+ description: |
+ This set of attributes specifies specification types.
+ required-attributes: all
+spec-name: Specification Item Type
+spec-type: spec
+type: spec