Skip to content

Commit abbb8ae

Browse files
sametozcanclaude
andcommitted
docs: Rename folder schemas to first-class resource naming
Folders are a top-level resource that can hold both articles and internal articles. Rename internal_article_folder* schemas to folder* to reflect this. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ab102b2 commit abbb8ae

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2701,7 +2701,7 @@ paths:
27012701
per_page: 50
27022702
total_pages: 1
27032703
schema:
2704-
"$ref": "#/components/schemas/internal_article_folder_list"
2704+
"$ref": "#/components/schemas/folder_list"
27052705
'401':
27062706
description: Unauthorized
27072707
content:
@@ -2723,7 +2723,7 @@ paths:
27232723
content:
27242724
application/json:
27252725
schema:
2726-
"$ref": "#/components/schemas/create_internal_article_folder_request"
2726+
"$ref": "#/components/schemas/create_folder_request"
27272727
example:
27282728
folder:
27292729
name: Product Documentation
@@ -2744,7 +2744,7 @@ paths:
27442744
created_at: 1672928359
27452745
updated_at: 1672928359
27462746
schema:
2747-
"$ref": "#/components/schemas/internal_article_folder"
2747+
"$ref": "#/components/schemas/folder"
27482748
'422':
27492749
description: Validation error
27502750
content:
@@ -2785,7 +2785,7 @@ paths:
27852785
created_at: 1672928359
27862786
updated_at: 1672928610
27872787
schema:
2788-
"$ref": "#/components/schemas/internal_article_folder"
2788+
"$ref": "#/components/schemas/folder"
27892789
'404':
27902790
description: Folder not found
27912791
content:
@@ -2814,7 +2814,7 @@ paths:
28142814
content:
28152815
application/json:
28162816
schema:
2817-
"$ref": "#/components/schemas/update_internal_article_folder_request"
2817+
"$ref": "#/components/schemas/update_folder_request"
28182818
example:
28192819
folder:
28202820
name: Updated Product Documentation
@@ -2834,7 +2834,7 @@ paths:
28342834
created_at: 1672928359
28352835
updated_at: 1672928900
28362836
schema:
2837-
"$ref": "#/components/schemas/internal_article_folder"
2837+
"$ref": "#/components/schemas/folder"
28382838
'404':
28392839
description: Folder not found
28402840
content:
@@ -16951,12 +16951,12 @@ components:
1695116951
description: An array of Internal Article objects
1695216952
items:
1695316953
"$ref": "#/components/schemas/internal_article_list_item"
16954-
internal_article_folder:
16955-
title: Internal Article Folder
16954+
folder:
16955+
title: Folder
1695616956
type: object
1695716957
x-tags:
16958-
- Internal Articles
16959-
description: A folder for organizing internal articles
16958+
- Folders
16959+
description: A folder for organizing content
1696016960
properties:
1696116961
id:
1696216962
type: integer
@@ -16995,12 +16995,12 @@ components:
1699516995
format: date-time
1699616996
description: The time when the folder was last updated (seconds)
1699716997
example: 1672928610
16998-
internal_article_folder_list:
16999-
title: Internal Article Folder List
16998+
folder_list:
16999+
title: Folder List
1700017000
type: object
1700117001
x-tags:
17002-
- Internal Articles
17003-
description: A list of folders for internal articles
17002+
- Folders
17003+
description: A paginated list of folders
1700417004
properties:
1700517005
type:
1700617006
type: string
@@ -17010,18 +17010,18 @@ components:
1701017010
data:
1701117011
type: array
1701217012
items:
17013-
"$ref": "#/components/schemas/internal_article_folder"
17013+
"$ref": "#/components/schemas/folder"
1701417014
total_count:
1701517015
type: integer
1701617016
description: Total number of folders
1701717017
example: 2
1701817018
pages:
1701917019
"$ref": "#/components/schemas/cursor_pages"
17020-
create_internal_article_folder_request:
17021-
title: Create Internal Article Folder Request
17020+
create_folder_request:
17021+
title: Create Folder Request
1702217022
type: object
1702317023
x-tags:
17024-
- Internal Articles
17024+
- Folders
1702517025
description: Request payload for creating a folder
1702617026
required:
1702717027
- folder
@@ -17067,11 +17067,11 @@ components:
1706717067
type: boolean
1706817068
description: Whether the folder was successfully deleted.
1706917069
example: true
17070-
update_internal_article_folder_request:
17071-
title: Update Internal Article Folder Request
17070+
update_folder_request:
17071+
title: Update Folder Request
1707217072
type: object
1707317073
x-tags:
17074-
- Internal Articles
17074+
- Folders
1707517075
description: Request payload for updating a folder
1707617076
required:
1707717077
- folder

0 commit comments

Comments
 (0)