summaryrefslogtreecommitdiff
path: root/spec/spec/spec-mandatory-attributes.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-04 10:34:56 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-06-08 08:59:20 +0200
commit9499f8bc3ff935c507c2d7fc36d5debb6949b89d (patch)
treea3e564298790bbb272349def292fefd7d5696ba0 /spec/spec/spec-mandatory-attributes.yml
parentf99047547159c41f363f96a36b4d134258ea52c8 (diff)
spec: Rename required in mandatory attributes
The term "required" is quite overloaded in the specification context. Use "mandatory" instead. Shorten the phrase "explicitly defined attributes" to "explicit attributes".
Diffstat (limited to 'spec/spec/spec-mandatory-attributes.yml')
-rw-r--r--spec/spec/spec-mandatory-attributes.yml30
1 files changed, 30 insertions, 0 deletions
diff --git a/spec/spec/spec-mandatory-attributes.yml b/spec/spec/spec-mandatory-attributes.yml
new file mode 100644
index 00000000..700de958
--- /dev/null
+++ b/spec/spec/spec-mandatory-attributes.yml
@@ -0,0 +1,30 @@
+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
+spec-description: |
+ It defines which explicit attributes are mandatory.
+spec-example: null
+spec-info:
+ list:
+ description: |
+ The list defines the mandatory attributes through their key names.
+ spec-type: name
+ str:
+ assert:
+ in:
+ - all
+ - at-least-one
+ - at-most-one
+ - exactly-one
+ - none
+ description: |
+ It defines how many explicit attributes are mandatory. If `none` is
+ used, then none of the explicit attributes is mandatory, they are all
+ optional.
+spec-name: Specification Mandatory Attributes
+spec-type: spec-mandatory-attributes
+type: spec