Add fin guidance applied schema in event_details in the conversations API #288
+23
−0
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.
Why?
To support the inclusion of a new
conversation_part.type
value:fin_guidance_applied
. This update ensures the OpenAPI spec reflects the new object structure returned by the Conversations API when this part type is present.What’s included?
Added a new schema under
components/schemas
:fin_guidance_applied
Describes the structure of the guidance objects applied to a conversation part
Includes
id
andtitle
as required fields for each guidanceUpdated the
event_details
schema to include a reference tofin_guidance_applied
, allowing this to be documented alongside other supported event types