Skip to content

Commit ab102b2

Browse files
sametozcanclaude
andcommitted
docs: Update Folders API and add folder_id to article schemas
- Add parent_folder_id query param to GET /folders for hierarchy filtering - Rename article_count to content_count to match monolith presenter - Add folder_id to article_list_item, create/update article requests - Add folder_id to update_internal_article_request - Add phrase query param and fix folder_id type on internal articles search - Add deleted_folder_object schema for delete response - Fix owner_id description in update_internal_article_request Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 41c613e commit ab102b2

File tree

1 file changed

+67
-10
lines changed

1 file changed

+67
-10
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 67 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2591,8 +2591,15 @@ paths:
25912591
- name: folder_id
25922592
in: query
25932593
required: false
2594-
description: The ID of the folder to search in.
2594+
description: The ID of the folder to search in. Results will include articles from this folder and all its descendant folders.
25952595
example: 123
2596+
schema:
2597+
type: integer
2598+
- name: phrase
2599+
in: query
2600+
required: false
2601+
description: The search phrase to filter internal articles by.
2602+
example: getting started
25962603
schema:
25972604
type: string
25982605
tags:
@@ -2612,10 +2619,12 @@ paths:
26122619
data:
26132620
internal_articles:
26142621
- id: '55'
2622+
title: Getting Started Guide
26152623
body: Body of the Article
26162624
owner_id: 991266252
26172625
author_id: 991266252
26182626
locale: en
2627+
folder_id: 123
26192628
pages:
26202629
type: pages
26212630
page: 1
@@ -2658,6 +2667,13 @@ paths:
26582667
type: integer
26592668
example: 50
26602669
maximum: 150
2670+
- name: parent_folder_id
2671+
in: query
2672+
required: false
2673+
description: Filter folders by parent folder ID. Use this to list only direct children of a specific folder.
2674+
schema:
2675+
type: integer
2676+
example: 1
26612677
tags:
26622678
- Folders
26632679
operationId: listFolders
@@ -2675,7 +2691,7 @@ paths:
26752691
description: Internal product docs
26762692
emoji: "📚"
26772693
parent_folder_id: null
2678-
article_count: 5
2694+
content_count: 5
26792695
created_at: 1672928359
26802696
updated_at: 1672928610
26812697
total_count: 1
@@ -2724,7 +2740,7 @@ paths:
27242740
description: Internal product docs
27252741
emoji: "📚"
27262742
parent_folder_id: null
2727-
article_count: 0
2743+
content_count: 0
27282744
created_at: 1672928359
27292745
updated_at: 1672928359
27302746
schema:
@@ -2765,7 +2781,7 @@ paths:
27652781
description: Internal product docs
27662782
emoji: "📚"
27672783
parent_folder_id: null
2768-
article_count: 5
2784+
content_count: 5
27692785
created_at: 1672928359
27702786
updated_at: 1672928610
27712787
schema:
@@ -2814,7 +2830,7 @@ paths:
28142830
description: Internal product docs
28152831
emoji: "📖"
28162832
parent_folder_id: null
2817-
article_count: 5
2833+
content_count: 5
28182834
created_at: 1672928359
28192835
updated_at: 1672928900
28202836
schema:
@@ -2842,7 +2858,7 @@ paths:
28422858
tags:
28432859
- Folders
28442860
operationId: deleteFolder
2845-
description: "You can delete a folder (if it contains no articles) by making a DELETE request to `https://api.intercom.io/folders/<id>`."
2861+
description: "You can delete a folder (if it contains no content) by making a DELETE request to `https://api.intercom.io/folders/<id>`."
28462862
responses:
28472863
'200':
28482864
description: folder deleted
@@ -2852,14 +2868,16 @@ paths:
28522868
id: 6
28532869
object: folder
28542870
deleted: true
2871+
schema:
2872+
"$ref": "#/components/schemas/deleted_folder_object"
28552873
'404':
28562874
description: Folder not found
28572875
content:
28582876
application/json:
28592877
schema:
28602878
"$ref": "#/components/schemas/error"
28612879
'422':
2862-
description: Folder contains articles
2880+
description: Folder contains content
28632881
content:
28642882
application/json:
28652883
schema:
@@ -16963,9 +16981,9 @@ components:
1696316981
nullable: true
1696416982
description: The ID of the parent folder, or null if this is a root folder
1696516983
example: null
16966-
article_count:
16984+
content_count:
1696716985
type: integer
16968-
description: The number of articles in this folder
16986+
description: The number of content items in this folder
1696916987
example: 5
1697016988
created_at:
1697116989
type: integer
@@ -17030,6 +17048,25 @@ components:
1703017048
nullable: true
1703117049
description: The ID of the parent folder
1703217050
example: null
17051+
deleted_folder_object:
17052+
title: Deleted Folder Object
17053+
type: object
17054+
description: Response returned when a folder is deleted
17055+
properties:
17056+
id:
17057+
type: integer
17058+
description: The unique identifier for the deleted folder
17059+
example: 6
17060+
object:
17061+
type: string
17062+
description: The type of object - `folder`.
17063+
enum:
17064+
- folder
17065+
example: folder
17066+
deleted:
17067+
type: boolean
17068+
description: Whether the folder was successfully deleted.
17069+
example: true
1703317070
update_internal_article_folder_request:
1703417071
title: Update Internal Article Folder Request
1703517072
type: object
@@ -17185,6 +17222,11 @@ components:
1718517222
"$ref": "#/components/schemas/article_translated_content"
1718617223
tags:
1718717224
"$ref": "#/components/schemas/tags"
17225+
folder_id:
17226+
type: integer
17227+
nullable: true
17228+
description: The ID of the folder this article belongs to, or null if not in a folder.
17229+
example: 6
1718817230
internal_article_list_item:
1718917231
title: Internal Articles
1719017232
type: object
@@ -19643,6 +19685,11 @@ components:
1964319685
example: collection
1964419686
translated_content:
1964519687
"$ref": "#/components/schemas/article_translated_content"
19688+
folder_id:
19689+
type: integer
19690+
nullable: true
19691+
description: The ID of the folder to place this article in, or null to leave it without a folder.
19692+
example: 6
1964619693
required:
1964719694
- title
1964819695
- author_id
@@ -24704,6 +24751,11 @@ components:
2470424751
example: collection
2470524752
translated_content:
2470624753
"$ref": "#/components/schemas/article_translated_content"
24754+
folder_id:
24755+
type: integer
24756+
nullable: true
24757+
description: The ID of the folder to place this article in, or null to remove it from its folder.
24758+
example: 6
2470724759
update_internal_article_request:
2470824760
description: You can Update an Internal Article
2470924761
type: object
@@ -24723,8 +24775,13 @@ components:
2472324775
example: 1295
2472424776
owner_id:
2472524777
type: integer
24726-
description: The id of the author of the article.
24778+
description: The id of the owner of the article.
2472724779
example: 1295
24780+
folder_id:
24781+
type: integer
24782+
nullable: true
24783+
description: The ID of the folder to place this article in, or null to remove it from its folder.
24784+
example: 6
2472824785
update_collection_request:
2472924786
description: You can update a collection
2473024787
type: object

0 commit comments

Comments
 (0)