Skip to content

Commit aa3f37c

Browse files
sametozcanclaude
andcommitted
docs: Refactor folder endpoints to top-level /folders
Update OpenAPI specification to reflect folder endpoints moving from /internal_articles/folders to top-level /folders resource. Changes: - Update paths: /internal_articles/folders → /folders - Update operation IDs: Remove "InternalArticle" prefix - Change tags: "Internal Articles" → "Folders" - Update descriptions: Remove "for internal articles" references - Remove bulk move endpoint /internal_articles/move_to_folder This makes folders a first-class organizational structure that can be used across multiple content types, not just internal articles. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 730888f commit aa3f37c

File tree

1 file changed

+17
-92
lines changed

1 file changed

+17
-92
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 17 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -2631,7 +2631,7 @@ paths:
26312631
message: Access Token Invalid
26322632
schema:
26332633
"$ref": "#/components/schemas/error"
2634-
"/internal_articles/folders":
2634+
"/folders":
26352635
get:
26362636
summary: List all folders
26372637
parameters:
@@ -2653,9 +2653,9 @@ paths:
26532653
example: 50
26542654
maximum: 150
26552655
tags:
2656-
- Internal Articles
2657-
operationId: listInternalArticleFolders
2658-
description: "You can fetch a list of all folders for internal articles by making a GET request to `https://api.intercom.io/internal_articles/folders`."
2656+
- Folders
2657+
operationId: listFolders
2658+
description: "You can fetch a list of all folders for organizing content by making a GET request to `https://api.intercom.io/folders`."
26592659
responses:
26602660
'200':
26612661
description: successful
@@ -2694,9 +2694,9 @@ paths:
26942694
schema:
26952695
"$ref": "#/components/schemas/intercom_version"
26962696
tags:
2697-
- Internal Articles
2698-
operationId: createInternalArticleFolder
2699-
description: "You can create a new folder for internal articles by making a POST request to `https://api.intercom.io/internal_articles/folders`."
2697+
- Folders
2698+
operationId: createFolder
2699+
description: "You can create a new folder for organizing content by making a POST request to `https://api.intercom.io/folders`."
27002700
requestBody:
27012701
content:
27022702
application/json:
@@ -2729,7 +2729,7 @@ paths:
27292729
application/json:
27302730
schema:
27312731
"$ref": "#/components/schemas/error"
2732-
"/internal_articles/folders/{id}":
2732+
"/folders/{id}":
27332733
get:
27342734
summary: Retrieve a folder
27352735
parameters:
@@ -2745,9 +2745,9 @@ paths:
27452745
type: integer
27462746
example: 6
27472747
tags:
2748-
- Internal Articles
2749-
operationId: retrieveInternalArticleFolder
2750-
description: "You can fetch the details of a single folder by making a GET request to `https://api.intercom.io/internal_articles/folders/<id>`."
2748+
- Folders
2749+
operationId: retrieveFolder
2750+
description: "You can fetch the details of a single folder by making a GET request to `https://api.intercom.io/folders/<id>`."
27512751
responses:
27522752
'200':
27532753
description: folder found
@@ -2785,9 +2785,9 @@ paths:
27852785
type: integer
27862786
example: 6
27872787
tags:
2788-
- Internal Articles
2789-
operationId: updateInternalArticleFolder
2790-
description: "You can update a folder by making a PUT request to `https://api.intercom.io/internal_articles/folders/<id>`."
2788+
- Folders
2789+
operationId: updateFolder
2790+
description: "You can update a folder by making a PUT request to `https://api.intercom.io/folders/<id>`."
27912791
requestBody:
27922792
content:
27932793
application/json:
@@ -2834,9 +2834,9 @@ paths:
28342834
type: integer
28352835
example: 6
28362836
tags:
2837-
- Internal Articles
2838-
operationId: deleteInternalArticleFolder
2839-
description: "You can delete a folder (if it contains no articles) by making a DELETE request to `https://api.intercom.io/internal_articles/folders/<id>`."
2837+
- Folders
2838+
operationId: deleteFolder
2839+
description: "You can delete a folder (if it contains no articles) by making a DELETE request to `https://api.intercom.io/folders/<id>`."
28402840
responses:
28412841
'200':
28422842
description: folder deleted
@@ -2858,81 +2858,6 @@ paths:
28582858
application/json:
28592859
schema:
28602860
"$ref": "#/components/schemas/error"
2861-
"/internal_articles/move_to_folder":
2862-
post:
2863-
summary: Bulk move articles to folder
2864-
parameters:
2865-
- name: Intercom-Version
2866-
in: header
2867-
schema:
2868-
"$ref": "#/components/schemas/intercom_version"
2869-
tags:
2870-
- Internal Articles
2871-
operationId: moveInternalArticlesToFolder
2872-
description: "You can move multiple articles to a folder (or remove them from folders) by making a POST request to `https://api.intercom.io/internal_articles/move_to_folder`."
2873-
requestBody:
2874-
content:
2875-
application/json:
2876-
schema:
2877-
type: object
2878-
required:
2879-
- article_ids
2880-
- destination_folder_id
2881-
properties:
2882-
article_ids:
2883-
type: array
2884-
items:
2885-
type: integer
2886-
description: Array of article IDs to move
2887-
example: [123, 124, 125]
2888-
destination_folder_id:
2889-
oneOf:
2890-
- type: integer
2891-
- type: string
2892-
enum: ["root"]
2893-
description: Target folder ID, or "root" to remove from folders
2894-
example: 6
2895-
examples:
2896-
move_to_folder:
2897-
summary: Move articles to folder
2898-
value:
2899-
article_ids: [123, 124]
2900-
destination_folder_id: 6
2901-
move_to_root:
2902-
summary: Move articles to root
2903-
value:
2904-
article_ids: [123, 124]
2905-
destination_folder_id: "root"
2906-
responses:
2907-
'200':
2908-
description: articles moved
2909-
content:
2910-
application/json:
2911-
example:
2912-
moved_count: 2
2913-
destination_folder_id: 6
2914-
schema:
2915-
type: object
2916-
properties:
2917-
moved_count:
2918-
type: integer
2919-
description: Number of articles successfully moved
2920-
destination_folder_id:
2921-
type: integer
2922-
nullable: true
2923-
description: Target folder ID, or null if moved to root
2924-
'404':
2925-
description: Folder not found
2926-
content:
2927-
application/json:
2928-
schema:
2929-
"$ref": "#/components/schemas/error"
2930-
'422':
2931-
description: Validation error
2932-
content:
2933-
application/json:
2934-
schema:
2935-
"$ref": "#/components/schemas/error"
29362861
"/companies":
29372862
post:
29382863
summary: Create or Update a company

0 commit comments

Comments
 (0)