Skip to content

Add fin guidance applied schema in event_details in the conversations API #288

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

toquis
Copy link

@toquis toquis commented Aug 6, 2025

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 and title as required fields for each guidance

  • Updated the event_details schema to include a reference to fin_guidance_applied, allowing this to be documented alongside other supported event types

Comment on lines +18656 to +18658
required:
- id
- title
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these necessary? I think they're only relevant if this is an input object, but the concept of required attributes on a response object doesn't really make sense I don't think, WDYT?

@davymalone
Copy link
Contributor

davymalone commented Aug 6, 2025

This looks good, the change needs to be made in this repo as well. You can run the developer-docs app locally and see your changes in the local version of the documentation to verify this change is exactly what you want. See the readme. Once you've checked that's all ok and opened the PR there I can approve both. Make sure to include screenshots in the developer-docs PR so I can verify the change 👌

@@ -18634,6 +18634,28 @@ components:
type: string
description: Result of the workflow event
example: Finsihed waiting
fin_guidance_applied:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just realised as well, you're going to want to make these changes in the 2.13 version as well, 0 here refers to unstable but since your new change isn't versioned we'll need to update the docs for whichever version we're already documenting these event details

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