All notable changes to this project are documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Note: Version 0 of Semantic Versioning is handled differently from version 1 and above. The minor version will be incremented upon a breaking change and the patch version will be incremented for features.
- Explicit support for address ranges (#248)
- Additional application types synced to PlanX service development - notably
ldc.listedBuildingWorks
andapproval.conditions
(#197)
- Updated
ApplicationTypes
,ProjectTypes
andFileTypes
based on ODP Service development across whole planning application ecosystem (#201, #200, #198, #197, #182, #177, #176)
- Added new example payloads and their associated types, now organised in subdirectories by application type (#183):
- Added type definitions for Greater London Authority reporting requirements, like residential units etc (#192, #179, #178)
- Added type definitions for "documents submitted as data" (not yet represented in example payloads) (#180)
- Tightened type defintion for planning desigation "entities" (#196)
- Upgraded a number of technical dependencies via Dependabot
- Updated
ApplicationTypes
related to Works to Trees (wtt
) to reflect legal distinction of consent & notification (#150) - Updated
data.applicant.interest
todata.applicant.ownership.interest
for better service alignment (#168) - Updated all
LondonProperty
subfields to be optional, as not all application types are subject to the extra Greater London Authority reporting requirements (#164) - Fixed a typo in the
ProtectedSpaceDesignation
type (#155)
- Added a
validListedBuildingConsent
example payload (#158) - Added
data.application.fee.category
to communicate breakdown of total calculated fee by category of development (#157, #167) - Added union type definition
ApplicationFeeNotApplicable
to signal when a specific application type or journey does not have any associated costs, rather than displayingdata.application.fee.payable = 0
(#165)
- Split Outline application types in Minor & Major to better align to legislation (#151)
- Updated
ProjectTypes
to reflect Listed Building Consent and Minor & Major Planning Permission journeys (#152, #153) - Updated
Ownership
type definition to capture more information about agricultural tenants and a discrete declaration of accuracy related to notifying any owners (#159) - Upgraded a number of technical dependencies via Dependabot
- Updated
data.proposal.vehicleParking
todata.property.parking
&data.proposal.parking
to better align to Greater London Authority legislation for capturing existing count, proposed count, and difference in number of parking spaces per type of vehicle. Additionally dropsdata.proposal.details
heirarchy, as this organisation wasn't meaningful in any policy context (#136)
- Added change of use of land projects to supported
ProjectTypes
(#142)
- Added
service.metadata.fees
to communicate how the application fees were calculated, including policy references (#124) - Added a number of new
FileTypes
(#137, #133, #128) - Added type definitons to describe
CommunityInfrastructureLevy
planning charges on applicable applications (#135) - Added type definitions to describe existing & proposed
Materials
for applicable project types (#134)
- Improved GitHub Action & CI workflows to ensure schema.json and examples are building as expected on
main
and indist
releases (#132, #131) - Updated expired file URLs in example payloads (#139)
- Renamed two
PlanningDesignation
values that were previously incorrectly categorised as "designated land" (#125) - Removed duplicated "outbuildings" entries, now using singular "outbuilding" only, from
ProjectTypes
(#123) - Updated type
data.property.planning.designations.source
to includetext
&url
(#122) - Updated
metadata.source
as requirement for any provider, not only PlanX (#119)
- Adjusted build scripts so that generated examples in
/dist
have correct version numbers (#114, #115)
- Added
service.metadata.files
to communicate all required, recommended, and optional files requested from the user based on their responses for reference during assessment (#110) - Added additional
PlanningDesignations
(#106)
- Added additional
PlanningDesignations
(#99) - Added additional
ApplicationTypes
. Stay tuned for expanded example payloads in the next release! (#98)
- Added new optional text property
data.applicant.ownership.noticeReason
(#89)
- Added a number of additional supported
ProjectTypes
(#88) - Updated descriptions for
data.property.boundary
anddata.proposal.boundary
fields (#89)
date-time
format is now supplemented by a regex pattern to restrict to the RFC3339 ISO format (#75)
- Renamed
result
topreAssessment
and made optional, as applications from sources other than Planx are unlikely to provide this (#66)
- Added
url
topolicyRefs
underresponses
(#67) - Added additional values to
ApplicationTypes
data dictionary (#65, #72)
- Simplified
metadata
overall and updatedorganisation
to align to Planning Data local authority reference codes (#68, #71) - Adjusted shape of
data.property.planning
to better capture existingdesignations
and theirsources
, and illustrate future scope includingconditions
and more (#64, #70)
- Updated GeoJSON type definition to use NPM's
@types/geojson
(#59) - Adjusted shape of
data.applicant
&data.applicant.agent
contact details (#62) - Improved annotations and documentation throughout (#60, #61)
- Adjusted shape of
data.property.constraints.planning
and added aPlanningConstraint
definition (#50) - Added more granular values to the
ProjectType
definition (#55) - Improved examples, especially
data.proposal.details
(#54) - Minor naming and organisational adjustments throughout based on early feedback
- Corrected usage of JSON Schema
Date
format (#52)
- Dropped
metadata.service.publishedFlowId
, as this will always be inferrable fromflowId
and the session's dates (#57)
- Released our first full working draft 🎉