Skip to content

Commit 8184aad

Browse files
Add applied_at and applied_by fields to tag endpoint examples (#360)
* Add applied_at and applied_by fields to tag endpoint examples Update OpenAPI spec to reflect the VersionedTaggingPresenter changes: - Change GET /contacts/{id}/tags schema from tag_list to tags - Add applied_at and applied_by fields to all entity tag endpoint examples (contacts, conversations, tickets) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Use tag_basic schema for workspace-level tag endpoints Workspace-level endpoints (GET /tags, POST /tags, GET /tags/{id}) and embedded company tags use TagResponse, not VersionedTaggingPresenter, so they don't include applied_at/applied_by fields. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Make applied_at and applied_by nullable in tag schema DELETE tag endpoints are idempotent - they return 200 OK even when the tag wasn't applied. In that case, applied_at and applied_by are null. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com> * Revert GET /contacts/{id}/tags envelope to list/data format The original Intercom PR was reverted and replaced with one that keeps the existing { type: "list", data: [...] } envelope. Update the example and schema reference (tags -> tag_list) to match, and use the full tag schema for tag_list items so applied_at/applied_by are included. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent bb5bcd9 commit 8184aad

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4409,6 +4409,10 @@ paths:
44094409
- type: tag
44104410
id: '80'
44114411
name: Manual tag
4412+
applied_at: 1663597223
4413+
applied_by:
4414+
type: admin
4415+
id: '456'
44124416
schema:
44134417
"$ref": "#/components/schemas/tag_list"
44144418
'404':
@@ -4470,6 +4474,10 @@ paths:
44704474
type: tag
44714475
id: '81'
44724476
name: Manual tag
4477+
applied_at: 1663597223
4478+
applied_by:
4479+
type: admin
4480+
id: '456'
44734481
schema:
44744482
"$ref": "#/components/schemas/tag"
44754483
'404':
@@ -4572,6 +4580,10 @@ paths:
45724580
type: tag
45734581
id: '84'
45744582
name: Manual tag
4583+
applied_at: 1663597223
4584+
applied_by:
4585+
type: admin
4586+
id: '456'
45754587
schema:
45764588
"$ref": "#/components/schemas/tag"
45774589
'404':
@@ -5787,6 +5799,10 @@ paths:
57875799
type: tag
57885800
id: '86'
57895801
name: Manual tag
5802+
applied_at: 1663597223
5803+
applied_by:
5804+
type: admin
5805+
id: '456'
57905806
schema:
57915807
"$ref": "#/components/schemas/tag"
57925808
'404':
@@ -5886,6 +5902,10 @@ paths:
58865902
type: tag
58875903
id: '89'
58885904
name: Manual tag
5905+
applied_at: 1663597223
5906+
applied_by:
5907+
type: admin
5908+
id: '456'
58895909
schema:
58905910
"$ref": "#/components/schemas/tag"
58915911
'404':
@@ -12064,7 +12084,7 @@ paths:
1206412084
id: '105'
1206512085
name: test
1206612086
schema:
12067-
"$ref": "#/components/schemas/tag"
12087+
"$ref": "#/components/schemas/tag_basic"
1206812088
'400':
1206912089
description: Invalid parameters
1207012090
content:
@@ -12177,7 +12197,7 @@ paths:
1217712197
id: '113'
1217812198
name: Manual tag
1217912199
schema:
12180-
"$ref": "#/components/schemas/tag"
12200+
"$ref": "#/components/schemas/tag_basic"
1218112201
'404':
1218212202
description: Tag not found
1218312203
content:
@@ -13451,6 +13471,10 @@ paths:
1345113471
type: tag
1345213472
id: '121'
1345313473
name: Manual tag
13474+
applied_at: 1663597223
13475+
applied_by:
13476+
type: admin
13477+
id: '456'
1345413478
schema:
1345513479
"$ref": "#/components/schemas/tag"
1345613480
'404':
@@ -13550,6 +13574,10 @@ paths:
1355013574
type: tag
1355113575
id: '124'
1355213576
name: Manual tag
13577+
applied_at: 1663597223
13578+
applied_by:
13579+
type: admin
13580+
id: '456'
1355313581
schema:
1355413582
"$ref": "#/components/schemas/tag"
1355513583
'404':
@@ -16895,8 +16923,7 @@ components:
1689516923
tags:
1689616924
type: array
1689716925
items:
16898-
items:
16899-
"$ref": "#/components/schemas/tag"
16926+
"$ref": "#/components/schemas/tag_basic"
1690016927
segments:
1690116928
type: object
1690216929
description: The list of segments associated with the company
@@ -22397,10 +22424,15 @@ components:
2239722424
applied_at:
2239822425
type: integer
2239922426
format: date-time
22427+
nullable: true
2240022428
description: The time when the tag was applied to the object
2240122429
example: 1663597223
2240222430
applied_by:
22403-
"$ref": "#/components/schemas/reference"
22431+
type: object
22432+
nullable: true
22433+
description: The admin who applied the tag
22434+
allOf:
22435+
- "$ref": "#/components/schemas/reference"
2240422436
tag_basic:
2240522437
title: Tag
2240622438
type: object

0 commit comments

Comments
 (0)