feat: Responses type
#29
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Next steps all sound sensible to me - I think this is probably a good opportunity to return out an enriched crumb and hold this format where we can really. It probably does make a little more sense to approach this once PlanX is really generating it though? Section Name as an enum or string is a tricky one. I think it should initially be a string but if BOPS require it be hardcoded, then in future when checking if a flow is valid we could easily check against the schema? |
DafyddLlyr
approved these changes
Sep 18, 2023
types/schema/Responses.ts
Outdated
Comment on lines
8
to
15
| auto_answered?: boolean; | ||
| policy_refs?: Array<{ | ||
| url?: string; | ||
| text?: string; | ||
| }>; | ||
| section_name?: string; | ||
| feedback?: string; | ||
| notes?: string; |
There was a problem hiding this comment.
nit: We should probably stick to camelCase here and consumers can map to their desired format?
DafyddLlyr
approved these changes
Sep 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Matches BOPS
proposal_details(docs) as a first go, but future direction should probably look a bit more like the new concept of an "enriched breadcrumb" (docs) in my opinion.To get to that future, tweaks/enhancements I think we'd want to make to
EnrichedBreadcrumbare:sectionId→sectionName(do we need to enum these so they are version controlled values? do consumers care?)questionMetadata&answerMetadata- eg individual answers pick up flags, which isn't currently reflected in the enriched breadcrumb yet