Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: data.property.planning type should use more precise language #64

Merged
merged 4 commits into from
Nov 9, 2023

Conversation

jessicamcinchak
Copy link
Member

@jessicamcinchak jessicamcinchak commented Nov 1, 2023

Changes:

  • intersects instead of overlaps to match actual spatial method used (eg DE-9IM definition)
  • adds source where we'll send Planx GIS API request to enable re-fetching, but another provided could put any URL
  • breaks down constraints into more specific groupings per advice from Alastair & Emily (see thread)
    • any mix of various constraint categories can be sent, a source is required if sending any category
    • the specific keys of designations & orders have expected enums, but others are currently flexible as Planx won't fulfill these yet
  /**
   * @description Planning constraints and policies that intersect with this site and may impact or restrict development
   */
  planning?: {
    /**
     * @description An open API request or website that explains how these constraints were sourced
     */
    source: URL;
    designations?: PlanningDesignation[];
    orders?: PlanningOrder[];
    conditions?: PlanningConstraint[];
    guidance?: PlanningConstraint[];
    plans?: {
      local: PlanningConstraint[];
      neighbourhood: PlanningConstraint[];
    };
  };

@jessicamcinchak jessicamcinchak marked this pull request as ready for review November 9, 2023 08:39
@jessicamcinchak jessicamcinchak requested a review from a team November 9, 2023 08:39
@jessicamcinchak jessicamcinchak changed the title fix: data.property.planning.constraints type should use more precise language fix: data.property.planning type should use more precise language Nov 9, 2023
@jessicamcinchak jessicamcinchak merged commit 3d9f187 into main Nov 9, 2023
3 checks passed
@jessicamcinchak jessicamcinchak deleted the jess/tighter-constraint-types branch November 9, 2023 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant