-
Notifications
You must be signed in to change notification settings - Fork 2
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
base: main
Are you sure you want to change the base?
Add fin guidance applied schema in event_details in the conversations API #288
Conversation
descriptions/0/api.intercom.io.yaml
Outdated
required: | ||
- id | ||
- title |
There was a problem hiding this comment.
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?
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: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, thanks for explaining the API versions. I have updated the PR to include the changes in that version.
I have created the PR in the developer-docs repo, with the same changes. I added the screenshots there. Feel free to review again when you have some time |
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