@pdtf/schemas 0.10.3 → 0.10.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdtf/schemas",
3
- "version": "0.10.3",
3
+ "version": "0.10.4",
4
4
  "description": "Property Data Trust Framework Schemas and Utilities",
5
5
  "main": "index.js",
6
6
  "directories": {
@@ -32,11 +32,6 @@
32
32
  "consumerProtectionRegulationsDeclaration"
33
33
  ],
34
34
  "properties": {
35
- "uprn": {
36
- "RDSRef": "Property/GUID/{name='UPRN',id=?}",
37
- "title": "Unique Property Reference Number ",
38
- "type": "integer"
39
- },
40
35
  "address": {
41
36
  "baspiRef": "A1.1",
42
37
  "lawSocietyRef": "TA6/0",
@@ -44,60 +39,91 @@
44
39
  "title": "Property Address",
45
40
  "$ref": "#/$defs/address"
46
41
  },
42
+ "uprn": {
43
+ "baspiRef": "A1.1.1",
44
+ "RDSRef": "Property/GUID/{name='UPRN',id=?}",
45
+ "title": "Unique Property Reference Number ",
46
+ "type": "integer"
47
+ },
47
48
  "propertyType": {
49
+ "title": "Type of property",
48
50
  "type": "string"
49
51
  },
50
52
  "isNewBuild": {
53
+ "title": "Is the property a New Build?",
51
54
  "type": "boolean"
52
55
  },
53
56
  "location": {
54
- "latitude": {
55
- "type": "number",
56
- "minimum": -90,
57
- "maximum": 90
58
- },
59
- "longitude": {
60
- "type": "number",
61
- "minimum": -180,
62
- "maximum": 180
57
+ "title": "Geographical location",
58
+ "type": "object",
59
+ "properties": {
60
+ "latitude": {
61
+ "title": "Latitude",
62
+ "type": "number",
63
+ "minimum": -90,
64
+ "maximum": 90
65
+ },
66
+ "longitude": {
67
+ "title": "Longitude",
68
+ "type": "number",
69
+ "minimum": -180,
70
+ "maximum": 180
71
+ }
63
72
  }
64
73
  },
65
74
  "localAuthority": {
66
- "localAuthorityName": {
67
- "type": "string"
68
- },
69
- "localAuthorityReference": {
70
- "type": "string"
75
+ "title": "Local authority",
76
+ "type": "object",
77
+ "properties": {
78
+ "localAuthorityName": {
79
+ "title": "Local authority name",
80
+ "type": "string"
81
+ },
82
+ "localAuthorityReference": {
83
+ "title": "Local authority reference",
84
+ "type": "string"
85
+ }
71
86
  }
72
87
  },
73
88
  "priceInformation": {
74
- "price": {
75
- "type": "number",
76
- "minimum": 1
77
- },
78
- "priceQualifier": {
79
- "type": "string",
80
- "enum": [
81
- "POA",
82
- "Guide price",
83
- "Fixed price",
84
- "Offers in excess of",
85
- "Offers in region of",
86
- "Sale by tender"
87
- ]
89
+ "ntsRef": "A3",
90
+ "title": "Price information",
91
+ "type": "object",
92
+ "properties": {
93
+ "price": {
94
+ "ntsRef": "A3.1",
95
+ "title": "Price",
96
+ "type": "number",
97
+ "minimum": 1
98
+ },
99
+ "priceQualifier": {
100
+ "ntsRef": "A3.2",
101
+ "title": "Price type",
102
+ "type": "string",
103
+ "enum": [
104
+ "POA",
105
+ "Guide price",
106
+ "Fixed price",
107
+ "Offers in excess of",
108
+ "Offers in region of",
109
+ "Sale by tender"
110
+ ]
111
+ }
88
112
  }
89
113
  },
90
114
  "summaryDescription": {
115
+ "title": "Summary description",
91
116
  "type": "string"
92
117
  },
93
118
  "media": {
119
+ "title": "Media",
94
120
  "type": "array",
95
121
  "items": {
96
122
  "type": "object",
97
- "title": "Media item",
98
123
  "required": ["mediaUrl"],
99
124
  "properties": {
100
125
  "mediaType": {
126
+ "title": "Type of media",
101
127
  "type": "string",
102
128
  "enum": [
103
129
  "Image",
@@ -110,12 +136,11 @@
110
136
  ]
111
137
  },
112
138
  "mediaUrl": {
139
+ "title": "Media URL",
113
140
  "type": "string",
114
141
  "format": "uri"
115
142
  },
116
- "caption": {
117
- "type": "string"
118
- }
143
+ "caption": { "title": "Caption", "type": "string" }
119
144
  }
120
145
  }
121
146
  },
@@ -642,12 +667,14 @@
642
667
  },
643
668
  "councilTax": {
644
669
  "baspiRef": "A1.9",
670
+ "ntsRef": "A2",
645
671
  "title": "Council Tax",
646
672
  "type": "object",
647
673
  "required": ["councilTaxBand", "councilTaxAffectingAlterations"],
648
674
  "properties": {
649
675
  "councilTaxBand": {
650
676
  "baspiRef": "A1.9.1",
677
+ "ntsRef": "A2.1",
651
678
  "RDSRef": "TenureAgreements/Taxes/{banding=?}",
652
679
  "title": "Which Council Tax band does this property fall within?",
653
680
  "type": "string",