Add "circumstances" list for inputs (#6)

opws · Nov 15, 2017 · a6e13e4 · a6e13e4
1 parent c492cbc
commit a6e13e4
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/draft/docs/forms.md b/draft/docs/forms.md
@@ -12,6 +12,8 @@ Properties of forms that describe input fields consist of objects with an `input
 
 Most inputs are assumed to be clear-text, but password inputs are assumed to be masked. In situations where this is not the case, a `characters` property will also be on the input, stating that an input is `masked` or `shown`, or, if the input allows the mask state to be toggled, `showable` or `maskable` (based on the respective initial states).
 
+Inputs that appear separately from the rest of the form, or only appear under certain circumstances, may have a `circumstances` list describing these circumstances, following the [documentation on descriptions](descriptions.md).
+
 ### Username
 
 The `username` property object of forms describes inputs for a username attached to the account, following the definition of "username" from [the main documentation on profiles](profiles.md).

diff --git a/draft/profiles.copld.yaml b/draft/profiles.copld.yaml
@@ -92,6 +92,9 @@ definitions:
       masking:
         $ref: "#/definitions/maskedness"
 
+      circumstances:
+        $ref: "#/definitions/desclist"
+
   accountfield:
     type: object
     minProperties: 1
@@ -111,6 +114,9 @@ definitions:
         minItems: 2
         uniqueItems: true
 
+      circumstances:
+        $ref: "#/definitions/desclist"
+
   fieldvalue:
     type: object
     minProperties: 1
@@ -258,6 +264,9 @@ definitions:
         - ascii
         - question
 
+      circumstances:
+        $ref: "#/definitions/desclist"
+
   resetrequest:
     type: object
     minProperties: 1
@@ -860,6 +869,9 @@ properties:
           - implicit
           - checkbox
 
+        circumstances:
+          $ref: "#/definitions/desclist"
+
   login.:
 
     url:
@@ -890,6 +902,9 @@ properties:
           - checked
           - unchecked
 
+        circumstances:
+          $ref: "#/definitions/desclist"
+
   thirdparty.:
 
     auth.:

diff --git a/draft/profiles.json b/draft/profiles.json
@@ -94,6 +94,9 @@
         },
         "masking": {
           "$ref": "#/definitions/maskedness"
+        },
+        "circumstances": {
+          "$ref": "#/definitions/desclist"
         }
       }
     },
@@ -116,6 +119,9 @@
           },
           "minItems": 2,
           "uniqueItems": true
+        },
+        "circumstances": {
+          "$ref": "#/definitions/desclist"
         }
       }
     },
@@ -291,6 +297,9 @@
             "ascii",
             "question"
           ]
+        },
+        "circumstances": {
+          "$ref": "#/definitions/desclist"
         }
       }
     },
@@ -1153,6 +1162,9 @@
                     "implicit",
                     "checkbox"
                   ]
+                },
+                "circumstances": {
+                  "$ref": "#/definitions/desclist"
                 }
               },
               "minimumProperties": 1
@@ -1196,6 +1208,9 @@
                     "checked",
                     "unchecked"
                   ]
+                },
+                "circumstances": {
+                  "$ref": "#/definitions/desclist"
                 }
               },
               "minimumProperties": 1