Skip to content

Commit 41c613e

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 22fe409 commit 41c613e

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
@@ -2637,7 +2637,7 @@ paths:
26372637
message: Access Token Invalid
26382638
schema:
26392639
"$ref": "#/components/schemas/error"
2640-
"/internal_articles/folders":
2640+
"/folders":
26412641
get:
26422642
summary: List all folders
26432643
parameters:
@@ -2659,9 +2659,9 @@ paths:
26592659
example: 50
26602660
maximum: 150
26612661
tags:
2662-
- Internal Articles
2663-
operationId: listInternalArticleFolders
2664-
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`."
2662+
- Folders
2663+
operationId: listFolders
2664+
description: "You can fetch a list of all folders for organizing content by making a GET request to `https://api.intercom.io/folders`."
26652665
responses:
26662666
'200':
26672667
description: successful
@@ -2700,9 +2700,9 @@ paths:
27002700
schema:
27012701
"$ref": "#/components/schemas/intercom_version"
27022702
tags:
2703-
- Internal Articles
2704-
operationId: createInternalArticleFolder
2705-
description: "You can create a new folder for internal articles by making a POST request to `https://api.intercom.io/internal_articles/folders`."
2703+
- Folders
2704+
operationId: createFolder
2705+
description: "You can create a new folder for organizing content by making a POST request to `https://api.intercom.io/folders`."
27062706
requestBody:
27072707
content:
27082708
application/json:
@@ -2735,7 +2735,7 @@ paths:
27352735
application/json:
27362736
schema:
27372737
"$ref": "#/components/schemas/error"
2738-
"/internal_articles/folders/{id}":
2738+
"/folders/{id}":
27392739
get:
27402740
summary: Retrieve a folder
27412741
parameters:
@@ -2751,9 +2751,9 @@ paths:
27512751
type: integer
27522752
example: 6
27532753
tags:
2754-
- Internal Articles
2755-
operationId: retrieveInternalArticleFolder
2756-
description: "You can fetch the details of a single folder by making a GET request to `https://api.intercom.io/internal_articles/folders/<id>`."
2754+
- Folders
2755+
operationId: retrieveFolder
2756+
description: "You can fetch the details of a single folder by making a GET request to `https://api.intercom.io/folders/<id>`."
27572757
responses:
27582758
'200':
27592759
description: folder found
@@ -2791,9 +2791,9 @@ paths:
27912791
type: integer
27922792
example: 6
27932793
tags:
2794-
- Internal Articles
2795-
operationId: updateInternalArticleFolder
2796-
description: "You can update a folder by making a PUT request to `https://api.intercom.io/internal_articles/folders/<id>`."
2794+
- Folders
2795+
operationId: updateFolder
2796+
description: "You can update a folder by making a PUT request to `https://api.intercom.io/folders/<id>`."
27972797
requestBody:
27982798
content:
27992799
application/json:
@@ -2840,9 +2840,9 @@ paths:
28402840
type: integer
28412841
example: 6
28422842
tags:
2843-
- Internal Articles
2844-
operationId: deleteInternalArticleFolder
2845-
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>`."
2843+
- Folders
2844+
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>`."
28462846
responses:
28472847
'200':
28482848
description: folder deleted
@@ -2864,81 +2864,6 @@ paths:
28642864
application/json:
28652865
schema:
28662866
"$ref": "#/components/schemas/error"
2867-
"/internal_articles/move_to_folder":
2868-
post:
2869-
summary: Bulk move articles to folder
2870-
parameters:
2871-
- name: Intercom-Version
2872-
in: header
2873-
schema:
2874-
"$ref": "#/components/schemas/intercom_version"
2875-
tags:
2876-
- Internal Articles
2877-
operationId: moveInternalArticlesToFolder
2878-
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`."
2879-
requestBody:
2880-
content:
2881-
application/json:
2882-
schema:
2883-
type: object
2884-
required:
2885-
- article_ids
2886-
- destination_folder_id
2887-
properties:
2888-
article_ids:
2889-
type: array
2890-
items:
2891-
type: integer
2892-
description: Array of article IDs to move
2893-
example: [123, 124, 125]
2894-
destination_folder_id:
2895-
oneOf:
2896-
- type: integer
2897-
- type: string
2898-
enum: ["root"]
2899-
description: Target folder ID, or "root" to remove from folders
2900-
example: 6
2901-
examples:
2902-
move_to_folder:
2903-
summary: Move articles to folder
2904-
value:
2905-
article_ids: [123, 124]
2906-
destination_folder_id: 6
2907-
move_to_root:
2908-
summary: Move articles to root
2909-
value:
2910-
article_ids: [123, 124]
2911-
destination_folder_id: "root"
2912-
responses:
2913-
'200':
2914-
description: articles moved
2915-
content:
2916-
application/json:
2917-
example:
2918-
moved_count: 2
2919-
destination_folder_id: 6
2920-
schema:
2921-
type: object
2922-
properties:
2923-
moved_count:
2924-
type: integer
2925-
description: Number of articles successfully moved
2926-
destination_folder_id:
2927-
type: integer
2928-
nullable: true
2929-
description: Target folder ID, or null if moved to root
2930-
'404':
2931-
description: Folder not found
2932-
content:
2933-
application/json:
2934-
schema:
2935-
"$ref": "#/components/schemas/error"
2936-
'422':
2937-
description: Validation error
2938-
content:
2939-
application/json:
2940-
schema:
2941-
"$ref": "#/components/schemas/error"
29422867
"/companies":
29432868
post:
29442869
summary: Create or Update a company

0 commit comments

Comments
 (0)