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

Move source to BaseMetadata type #117

Closed
jessicamcinchak opened this issue Feb 13, 2024 · 2 comments · Fixed by #119
Closed

Move source to BaseMetadata type #117

jessicamcinchak opened this issue Feb 13, 2024 · 2 comments · Fixed by #119

Comments

@jessicamcinchak
Copy link
Member

No description provided.

@aaronwilliamsv1
Copy link

So as I understand it, source is currently a property of the extended interface PlanXMetaData:

/**
* @id #PlanXMetadata
* @description Additional metadata associated with applications submitted via PlanX
*/
export interface PlanXMetadata extends BaseMetadata {
source: 'PlanX';
service: {
flowId: UUID;
url: URL;
files: RequestedFiles;
};
}

And this issue is to move it from the extended interface, to the BaseMetaData interface:

export interface BaseMetadata {
/**
* @description The reference code for the organisation responsible for processing this planning application, sourced from planning.data.gov.uk/dataset/local-authority
* @maxLength 4
*/
organisation: string;
/**
* @description Unique identifier for this application
*/
id: UUID; // @todo align to DLUHC Planning Application API reference
submittedAt: DateTime;
schema: URL;
}

My question would be, what should be the default for source? Should it still be 'PlanX'? What is a 'default' organisation? Should it still be string?

@jessicamcinchak
Copy link
Member Author

@aaronwilliamsv1 thanks for questions here, please see latest proposal #119

Proposed changes:

  • source becomes required using an enum type, with a "default" state of "Any" (open to language suggestions here!)
  • organisation remains required and any string value without a "default". As I understand it, organisation will always reflect data.property.address (required).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants