Skip to content

Commit e00a597

Browse files
sametozcanclaude
andcommitted
docs: Remove phrase param, inline folder request/list schemas
- Remove phrase query param from internal articles search (not implemented) - Inline folder_list, create_folder_request, update_folder_request schemas directly into endpoint definitions instead of separate schema refs - Remove standalone schema definitions for the above - Keep folder and deleted_folder_object as reusable schemas Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent abbb8ae commit e00a597

File tree

1 file changed

+67
-93
lines changed

1 file changed

+67
-93
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 67 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -2595,13 +2595,6 @@ paths:
25952595
example: 123
25962596
schema:
25972597
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
2603-
schema:
2604-
type: string
26052598
tags:
26062599
- Internal Articles
26072600
operationId: searchInternalArticles
@@ -2619,7 +2612,6 @@ paths:
26192612
data:
26202613
internal_articles:
26212614
- id: '55'
2622-
title: Getting Started Guide
26232615
body: Body of the Article
26242616
owner_id: 991266252
26252617
author_id: 991266252
@@ -2701,7 +2693,23 @@ paths:
27012693
per_page: 50
27022694
total_pages: 1
27032695
schema:
2704-
"$ref": "#/components/schemas/folder_list"
2696+
type: object
2697+
properties:
2698+
type:
2699+
type: string
2700+
enum:
2701+
- list
2702+
example: list
2703+
data:
2704+
type: array
2705+
items:
2706+
"$ref": "#/components/schemas/folder"
2707+
total_count:
2708+
type: integer
2709+
description: Total number of folders
2710+
example: 2
2711+
pages:
2712+
"$ref": "#/components/schemas/cursor_pages"
27052713
'401':
27062714
description: Unauthorized
27072715
content:
@@ -2723,7 +2731,32 @@ paths:
27232731
content:
27242732
application/json:
27252733
schema:
2726-
"$ref": "#/components/schemas/create_folder_request"
2734+
type: object
2735+
required:
2736+
- folder
2737+
properties:
2738+
folder:
2739+
type: object
2740+
required:
2741+
- name
2742+
properties:
2743+
name:
2744+
type: string
2745+
description: The name of the folder
2746+
example: Product Documentation
2747+
description:
2748+
type: string
2749+
description: The description of the folder
2750+
example: Internal product documentation
2751+
emoji:
2752+
type: string
2753+
description: An emoji for the folder
2754+
example: "📚"
2755+
parent_folder_id:
2756+
type: integer
2757+
nullable: true
2758+
description: The ID of the parent folder
2759+
example: null
27272760
example:
27282761
folder:
27292762
name: Product Documentation
@@ -2814,7 +2847,30 @@ paths:
28142847
content:
28152848
application/json:
28162849
schema:
2817-
"$ref": "#/components/schemas/update_folder_request"
2850+
type: object
2851+
required:
2852+
- folder
2853+
properties:
2854+
folder:
2855+
type: object
2856+
properties:
2857+
name:
2858+
type: string
2859+
description: The name of the folder
2860+
example: Updated Product Documentation
2861+
description:
2862+
type: string
2863+
description: The description of the folder
2864+
example: Updated internal product documentation
2865+
emoji:
2866+
type: string
2867+
description: An emoji for the folder
2868+
example: "📖"
2869+
parent_folder_id:
2870+
type: integer
2871+
nullable: true
2872+
description: The ID of the parent folder
2873+
example: null
28182874
example:
28192875
folder:
28202876
name: Updated Product Documentation
@@ -16995,59 +17051,6 @@ components:
1699517051
format: date-time
1699617052
description: The time when the folder was last updated (seconds)
1699717053
example: 1672928610
16998-
folder_list:
16999-
title: Folder List
17000-
type: object
17001-
x-tags:
17002-
- Folders
17003-
description: A paginated list of folders
17004-
properties:
17005-
type:
17006-
type: string
17007-
enum:
17008-
- list
17009-
example: list
17010-
data:
17011-
type: array
17012-
items:
17013-
"$ref": "#/components/schemas/folder"
17014-
total_count:
17015-
type: integer
17016-
description: Total number of folders
17017-
example: 2
17018-
pages:
17019-
"$ref": "#/components/schemas/cursor_pages"
17020-
create_folder_request:
17021-
title: Create Folder Request
17022-
type: object
17023-
x-tags:
17024-
- Folders
17025-
description: Request payload for creating a folder
17026-
required:
17027-
- folder
17028-
properties:
17029-
folder:
17030-
type: object
17031-
required:
17032-
- name
17033-
properties:
17034-
name:
17035-
type: string
17036-
description: The name of the folder
17037-
example: Product Documentation
17038-
description:
17039-
type: string
17040-
description: The description of the folder
17041-
example: Internal product documentation
17042-
emoji:
17043-
type: string
17044-
description: An emoji for the folder
17045-
example: "📚"
17046-
parent_folder_id:
17047-
type: integer
17048-
nullable: true
17049-
description: The ID of the parent folder
17050-
example: null
1705117054
deleted_folder_object:
1705217055
title: Deleted Folder Object
1705317056
type: object
@@ -17067,35 +17070,6 @@ components:
1706717070
type: boolean
1706817071
description: Whether the folder was successfully deleted.
1706917072
example: true
17070-
update_folder_request:
17071-
title: Update Folder Request
17072-
type: object
17073-
x-tags:
17074-
- Folders
17075-
description: Request payload for updating a folder
17076-
required:
17077-
- folder
17078-
properties:
17079-
folder:
17080-
type: object
17081-
properties:
17082-
name:
17083-
type: string
17084-
description: The name of the folder
17085-
example: Updated Product Documentation
17086-
description:
17087-
type: string
17088-
description: The description of the folder
17089-
example: Updated internal product documentation
17090-
emoji:
17091-
type: string
17092-
description: An emoji for the folder
17093-
example: "📖"
17094-
parent_folder_id:
17095-
type: integer
17096-
nullable: true
17097-
description: The ID of the parent folder
17098-
example: null
1709917073
article_list:
1710017074
title: Articles
1710117075
type: object

0 commit comments

Comments
 (0)