Skip to content

Commit c24e276

Browse files
committed
added descriptions and imprecise option for CountPrecision
1 parent 7802170 commit c24e276

2 files changed

Lines changed: 18 additions & 3 deletions

File tree

framework/json/common/beaconCommonComponents.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
"type": "string"
5757
},
5858
"CountAdjustedTo": {
59-
"description": "For counts with intentional (e.g. due to privacy concerns) or technical derived imprecision this parameter offers an option to declare the range or limits for the true results.",
59+
"description": "For counts with intentional (e.g. due to privacy concerns) or technical derived imprecision this parameter offers an option to declare the range or limits for the true results. \nIf present, CountPrecision states the type of adjustment.",
6060
"examples": [
6161
[
6262
"1",
@@ -78,9 +78,11 @@
7878
"type": "array"
7979
},
8080
"CountPrecision": {
81-
"default": "rounded",
81+
"description": "For counts with intentional (e.g. due to privacy concerns) or technical derived imprecision this parameter offers an option to declare the number's precision. \n If present, CountAdjustedTo provides more details. The 3 possible options are: \n* exact >- A value that is precise. \n* imprecise >-A value that is not guaranteed to be precise.\n* rounded >- A value that has been (floor or ceiling) rounded to a given value.",
82+
"default": "imprecise",
8283
"enum": [
8384
"exact",
85+
"imprecise",
8486
"rounded"
8587
],
8688
"type": "string"

framework/src/common/beaconCommonComponents.yaml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ $defs:
5555
For counts with intentional (e.g. due to privacy concerns) or technical
5656
derived imprecision this parameter offers an option to declare the range
5757
or limits for the true results.
58+
If present, CountPrecision states the type of adjustment.
5859
examples:
5960
- - "1"
6061
- "5"
@@ -68,10 +69,22 @@ $defs:
6869
- string
6970
minimum: 1
7071
CountPrecision:
72+
description: >-
73+
For counts with intentional (e.g. due to privacy concerns) or technical
74+
derived imprecision this parameter offers an option to declare the number's precision.
75+
If present, CountAdjustedTo provides more details.
76+
The 3 possible options are:
77+
- exact >-
78+
A value that is precise.
79+
- imprecise >-
80+
A value that is not guaranteed to be precise.
81+
- rounded >-
82+
A value that has been (floor or ceiling) rounded to a given value.
7183
enum:
7284
- exact
85+
- imprecise
7386
- rounded
74-
default: rounded
87+
default: imprecise
7588
type: string
7689
CURIE:
7790
pattern: ^\w[^:]+:.+$

0 commit comments

Comments
 (0)