Skip to content

Commit bc36066

Browse files
Propagate tag schema changes to API versions 2.7-2.15 (#364)
- Make applied_at nullable and applied_by a nullable object in tag schema - Add tag_basic schema (2.7-2.12; 2.13-2.15 already had it) - Use tag_basic for POST /tags and GET /tags/{id} response schemas - Fix double-nested items bug in company tags schema - Add applied_at/applied_by to entity tag endpoint examples Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent bb6dc17 commit bc36066

File tree

9 files changed

+429
-45
lines changed

9 files changed

+429
-45
lines changed

descriptions/2.10/api.intercom.io.yaml

Lines changed: 57 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2938,6 +2938,10 @@ paths:
29382938
- type: tag
29392939
id: '124'
29402940
name: Manual tag
2941+
applied_at: 1663597223
2942+
applied_by:
2943+
type: admin
2944+
id: '456'
29412945
schema:
29422946
"$ref": "#/components/schemas/tag_list"
29432947
'404':
@@ -2999,6 +3003,10 @@ paths:
29993003
type: tag
30003004
id: '125'
30013005
name: Manual tag
3006+
applied_at: 1663597223
3007+
applied_by:
3008+
type: admin
3009+
id: '456'
30023010
schema:
30033011
"$ref": "#/components/schemas/tag"
30043012
'404':
@@ -3101,6 +3109,10 @@ paths:
31013109
type: tag
31023110
id: '128'
31033111
name: Manual tag
3112+
applied_at: 1663597223
3113+
applied_by:
3114+
type: admin
3115+
id: '456'
31043116
schema:
31053117
"$ref": "#/components/schemas/tag"
31063118
'404':
@@ -4021,6 +4033,10 @@ paths:
40214033
type: tag
40224034
id: '130'
40234035
name: Manual tag
4036+
applied_at: 1663597223
4037+
applied_by:
4038+
type: admin
4039+
id: '456'
40244040
schema:
40254041
"$ref": "#/components/schemas/tag"
40264042
'404':
@@ -4120,6 +4136,10 @@ paths:
41204136
type: tag
41214137
id: '133'
41224138
name: Manual tag
4139+
applied_at: 1663597223
4140+
applied_by:
4141+
type: admin
4142+
id: '456'
41234143
schema:
41244144
"$ref": "#/components/schemas/tag"
41254145
'404':
@@ -8438,7 +8458,7 @@ paths:
84388458
id: '149'
84398459
name: test
84408460
schema:
8441-
"$ref": "#/components/schemas/tag"
8461+
"$ref": "#/components/schemas/tag_basic"
84428462
'400':
84438463
description: Invalid parameters
84448464
content:
@@ -8551,7 +8571,7 @@ paths:
85518571
id: '157'
85528572
name: Manual tag
85538573
schema:
8554-
"$ref": "#/components/schemas/tag"
8574+
"$ref": "#/components/schemas/tag_basic"
85558575
'404':
85568576
description: Tag not found
85578577
content:
@@ -9515,6 +9535,10 @@ paths:
95159535
type: tag
95169536
id: '165'
95179537
name: Manual tag
9538+
applied_at: 1663597223
9539+
applied_by:
9540+
type: admin
9541+
id: '456'
95189542
schema:
95199543
"$ref": "#/components/schemas/tag"
95209544
'404':
@@ -9614,6 +9638,10 @@ paths:
96149638
type: tag
96159639
id: '168'
96169640
name: Manual tag
9641+
applied_at: 1663597223
9642+
applied_by:
9643+
type: admin
9644+
id: '456'
96179645
schema:
96189646
"$ref": "#/components/schemas/tag"
96199647
'404':
@@ -12046,8 +12074,7 @@ components:
1204612074
tags:
1204712075
type: array
1204812076
items:
12049-
items:
12050-
"$ref": "#/components/schemas/tag"
12077+
"$ref": "#/components/schemas/tag_basic"
1205112078
segments:
1205212079
type: object
1205312080
description: The list of segments associated with the company
@@ -15801,10 +15828,35 @@ components:
1580115828
applied_at:
1580215829
type: integer
1580315830
format: date-time
15831+
nullable: true
1580415832
description: The time when the tag was applied to the object
1580515833
example: 1663597223
1580615834
applied_by:
15807-
"$ref": "#/components/schemas/reference"
15835+
type: object
15836+
nullable: true
15837+
description: The admin who applied the tag
15838+
allOf:
15839+
- "$ref": "#/components/schemas/reference"
15840+
tag_basic:
15841+
title: Tag
15842+
type: object
15843+
x-tags:
15844+
- Tags
15845+
description: A tag allows you to label your contacts, companies, and conversations
15846+
and list them using that tag.
15847+
properties:
15848+
type:
15849+
type: string
15850+
description: value is "tag"
15851+
example: tag
15852+
id:
15853+
type: string
15854+
description: The id of the tag
15855+
example: '123456'
15856+
name:
15857+
type: string
15858+
description: The name of the tag
15859+
example: Test tag
1580815860
tag_company_request:
1580915861
description: You can tag a single company or a list of companies.
1581015862
type: object

descriptions/2.11/api.intercom.io.yaml

Lines changed: 57 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3018,6 +3018,10 @@ paths:
30183018
- type: tag
30193019
id: '93'
30203020
name: Manual tag
3021+
applied_at: 1663597223
3022+
applied_by:
3023+
type: admin
3024+
id: '456'
30213025
schema:
30223026
"$ref": "#/components/schemas/tag_list"
30233027
'404':
@@ -3079,6 +3083,10 @@ paths:
30793083
type: tag
30803084
id: '94'
30813085
name: Manual tag
3086+
applied_at: 1663597223
3087+
applied_by:
3088+
type: admin
3089+
id: '456'
30823090
schema:
30833091
"$ref": "#/components/schemas/tag"
30843092
'404':
@@ -3181,6 +3189,10 @@ paths:
31813189
type: tag
31823190
id: '97'
31833191
name: Manual tag
3192+
applied_at: 1663597223
3193+
applied_by:
3194+
type: admin
3195+
id: '456'
31843196
schema:
31853197
"$ref": "#/components/schemas/tag"
31863198
'404':
@@ -4119,6 +4131,10 @@ paths:
41194131
type: tag
41204132
id: '99'
41214133
name: Manual tag
4134+
applied_at: 1663597223
4135+
applied_by:
4136+
type: admin
4137+
id: '456'
41224138
schema:
41234139
"$ref": "#/components/schemas/tag"
41244140
'404':
@@ -4218,6 +4234,10 @@ paths:
42184234
type: tag
42194235
id: '102'
42204236
name: Manual tag
4237+
applied_at: 1663597223
4238+
applied_by:
4239+
type: admin
4240+
id: '456'
42214241
schema:
42224242
"$ref": "#/components/schemas/tag"
42234243
'404':
@@ -8530,7 +8550,7 @@ paths:
85308550
id: '118'
85318551
name: test
85328552
schema:
8533-
"$ref": "#/components/schemas/tag"
8553+
"$ref": "#/components/schemas/tag_basic"
85348554
'400':
85358555
description: Invalid parameters
85368556
content:
@@ -8643,7 +8663,7 @@ paths:
86438663
id: '126'
86448664
name: Manual tag
86458665
schema:
8646-
"$ref": "#/components/schemas/tag"
8666+
"$ref": "#/components/schemas/tag_basic"
86478667
'404':
86488668
description: Tag not found
86498669
content:
@@ -9606,6 +9626,10 @@ paths:
96069626
type: tag
96079627
id: '134'
96089628
name: Manual tag
9629+
applied_at: 1663597223
9630+
applied_by:
9631+
type: admin
9632+
id: '456'
96099633
schema:
96109634
"$ref": "#/components/schemas/tag"
96119635
'404':
@@ -9705,6 +9729,10 @@ paths:
97059729
type: tag
97069730
id: '137'
97079731
name: Manual tag
9732+
applied_at: 1663597223
9733+
applied_by:
9734+
type: admin
9735+
id: '456'
97089736
schema:
97099737
"$ref": "#/components/schemas/tag"
97109738
'404':
@@ -12463,8 +12491,7 @@ components:
1246312491
tags:
1246412492
type: array
1246512493
items:
12466-
items:
12467-
"$ref": "#/components/schemas/tag"
12494+
"$ref": "#/components/schemas/tag_basic"
1246812495
segments:
1246912496
type: object
1247012497
description: The list of segments associated with the company
@@ -17451,16 +17478,41 @@ components:
1745117478
applied_at:
1745217479
type: integer
1745317480
format: date-time
17481+
nullable: true
1745417482
description: The time when the tag was applied to the object
1745517483
example: 1663597223
1745617484
applied_by:
17457-
"$ref": "#/components/schemas/reference"
17485+
type: object
17486+
nullable: true
17487+
description: The admin who applied the tag
17488+
allOf:
17489+
- "$ref": "#/components/schemas/reference"
1745817490
required:
1745917491
- type
1746017492
- id
1746117493
- name
1746217494
- applied_at
1746317495
- applied_by
17496+
tag_basic:
17497+
title: Tag
17498+
type: object
17499+
x-tags:
17500+
- Tags
17501+
description: A tag allows you to label your contacts, companies, and conversations
17502+
and list them using that tag.
17503+
properties:
17504+
type:
17505+
type: string
17506+
description: value is "tag"
17507+
example: tag
17508+
id:
17509+
type: string
17510+
description: The id of the tag
17511+
example: '123456'
17512+
name:
17513+
type: string
17514+
description: The name of the tag
17515+
example: Test tag
1746417516
tag_company_request:
1746517517
description: You can tag a single company or a list of companies.
1746617518
type: object

0 commit comments

Comments
 (0)