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: simplify Metadata type #68

Merged
merged 3 commits into from
Nov 8, 2023
Merged

Conversation

jessicamcinchak
Copy link
Member

@jessicamcinchak jessicamcinchak commented Nov 7, 2023

changes:

  • break definition out into extensible interfaces BaseMetadata and PlanxMetadata; this feels easier to scale to future contributors & requirements are less coupled to Planx expectations
  • remove redundant properties like metadata.service.name (instead inferrable from data.application.type)

outstanding questions / follow ups:

  • get an example of Planning Data's organisation curie - can we better type/document expected value for this?
  • are createdAt / submittedAt redundant? does the end-consumer actually care about the length of time between starting and submitting the application? should this is simply be one date that indicates when this payload is being submitted?

@jessicamcinchak jessicamcinchak marked this pull request as ready for review November 8, 2023 11:10
@jessicamcinchak jessicamcinchak requested a review from a team November 8, 2023 11:12
examples/data/ldcE.ts Show resolved Hide resolved
types/schema/Metadata.ts Outdated Show resolved Hide resolved
@jessicamcinchak jessicamcinchak merged commit f5b402f into main Nov 8, 2023
1 check passed
@jessicamcinchak jessicamcinchak deleted the jess/simplify-metadata branch November 8, 2023 14:40
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.

2 participants