Skip to content

Commit 02568c7

Browse files
marcmlcclaude
andauthored
Fix unstable API documentation issues (#291)
* add AddTeammateRatingUpdatedAtToConversation doc * add AddAiAgentRatingCreatedAtUpdatedAtToConversation * apply changes from dev-docs 524 * Fix fern check errors for data attribute request types Map snake_case schema names to PascalCase for CreateDataAttributeRequest and UpdateDataAttributeRequest to resolve type definition errors in fern check. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent 56170b8 commit 02568c7

File tree

2 files changed

+86
-32
lines changed

2 files changed

+86
-32
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 68 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15227,6 +15227,18 @@ components:
1522715227
description: The customer satisfaction rating remark given to AI Agent.
1522815228
example: Very helpful!
1522915229
nullable: true
15230+
created_at:
15231+
type: integer
15232+
format: date-time
15233+
description: The time when the AI agent rating was created.
15234+
example: 1663597260
15235+
nullable: true
15236+
updated_at:
15237+
type: integer
15238+
format: date-time
15239+
description: The time when the AI agent rating was last updated.
15240+
example: 1663597260
15241+
nullable: true
1523015242
content_sources:
1523115243
"$ref": "#/components/schemas/content_sources_list"
1523215244
app:
@@ -17496,6 +17508,11 @@ components:
1749617508
description: The time the rating was requested in the conversation being
1749717509
rated.
1749817510
example: 1671028894
17511+
updated_at:
17512+
type: integer
17513+
format: date-time
17514+
description: The time the rating was last updated.
17515+
example: 1671028894
1749917516
contact:
1750017517
"$ref": "#/components/schemas/contact_reference"
1750117518
teammate:
@@ -18045,38 +18062,48 @@ components:
1804518062
- contact
1804618063
- company
1804718064
example: contact
18048-
data_type:
18049-
type: string
18050-
description: The type of data stored for this attribute.
18051-
enum:
18052-
- string
18053-
- integer
18054-
- float
18055-
- boolean
18056-
- datetime
18057-
- date
18058-
example: string
1805918065
description:
1806018066
type: string
1806118067
description: The readable description you see in the UI for the attribute.
1806218068
example: My Data Attribute Description
18063-
options:
18064-
type: array
18065-
description: To create list attributes. Provide a set of hashes with `value`
18066-
as the key of the options you want to make. `data_type` must be `string`.
18067-
items:
18068-
type: string
18069-
example:
18070-
- option1
18071-
- option2
1807218069
messenger_writable:
1807318070
type: boolean
1807418071
description: Can this attribute be updated by the Messenger
1807518072
example: false
1807618073
required:
18077-
- name
18078-
- model
18079-
- data_type
18074+
- name
18075+
- model
18076+
- data_type
18077+
oneOf:
18078+
- properties:
18079+
data_type:
18080+
enum:
18081+
- options
18082+
options:
18083+
type: array
18084+
description: Array of objects representing the options of the list, with `value` as the key and the option as the value. At least
18085+
two options are required.
18086+
items:
18087+
type: object
18088+
properties:
18089+
value:
18090+
type: string
18091+
example:
18092+
- value: 1-10
18093+
- value: 11-50
18094+
required:
18095+
- options
18096+
title: 'list attribute'
18097+
- properties:
18098+
data_type:
18099+
enum:
18100+
- string
18101+
- integer
18102+
- float
18103+
- boolean
18104+
- datetime
18105+
- date
18106+
title: 'other type'
1808018107
create_data_event_request:
1808118108
description: ''
1808218109
type: object
@@ -22329,19 +22356,28 @@ components:
2232922356
type: string
2233022357
description: The readable description you see in the UI for the attribute.
2233122358
example: My Data Attribute Description
22332-
options:
22333-
type: array
22334-
description: To create list attributes. Provide a set of hashes with `value`
22335-
as the key of the options you want to make. `data_type` must be `string`.
22336-
items:
22337-
type: string
22338-
example:
22339-
- option1
22340-
- option2
2234122359
messenger_writable:
2234222360
type: boolean
2234322361
description: Can this attribute be updated by the Messenger
2234422362
example: false
22363+
oneOf:
22364+
- properties:
22365+
options:
22366+
type: array
22367+
description: Array of objects representing the options of the list, with `value` as the key and the option as the value. At least
22368+
two options are required.
22369+
items:
22370+
type: object
22371+
properties:
22372+
value:
22373+
type: string
22374+
example:
22375+
- value: 1-10
22376+
- value: 11-50
22377+
required:
22378+
- options
22379+
title: 'list attribute'
22380+
- title: 'other type'
2234522381
update_external_page_request:
2234622382
title: Update External Page Payload
2234722383
type: object

fern/unstable-openapi-overrides.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
11
paths:
2+
'/data_attributes':
3+
post:
4+
requestBody:
5+
content:
6+
application/json:
7+
schema:
8+
$ref: '#/components/schemas/CreateDataAttributeRequest'
9+
'/data_attributes/{id}':
10+
put:
11+
requestBody:
12+
content:
13+
application/json:
14+
schema:
15+
$ref: '#/components/schemas/UpdateDataAttributeRequest'
216
'/articles':
317
post:
418
requestBody:
@@ -98,6 +112,10 @@ paths:
98112

99113
components:
100114
schemas:
115+
create_data_attribute_request:
116+
x-fern-type-name: CreateDataAttributeRequest
117+
update_data_attribute_request:
118+
x-fern-type-name: UpdateDataAttributeRequest
101119
custom_attributes:
102120
example:
103121
monthly_spend: '155.5'

0 commit comments

Comments
 (0)