Skip to content

Commit 0b98ada

Browse files
efassorclaude
andcommitted
Fix OpenAPI spec issues based on code review
Fixes: - Remove company_id from request body (conflicts with path parameter) - Add 401 Unauthorized response - Clarify 404 description (company OR admin not found) - Improve admin_id description (explain default behavior) - Remove company_id from request examples Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 97339a6 commit 0b98ada

1 file changed

Lines changed: 10 additions & 12 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3366,8 +3366,14 @@ paths:
33663366
body: "<p>Hello</p>"
33673367
schema:
33683368
"$ref": "#/components/schemas/note"
3369+
'401':
3370+
description: Unauthorized
3371+
content:
3372+
application/json:
3373+
schema:
3374+
"$ref": "#/components/schemas/error"
33693375
'404':
3370-
description: Company not found
3376+
description: Company or admin not found
33713377
content:
33723378
application/json:
33733379
examples:
@@ -3399,32 +3405,24 @@ paths:
33993405
type: string
34003406
description: The text of the note.
34013407
example: New note
3402-
company_id:
3403-
type: string
3404-
description: The unique identifier of a given company.
3405-
example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
34063408
admin_id:
34073409
type: string
3408-
description: The unique identifier of a given admin.
3410+
description: The unique identifier of the admin creating the note. If not provided, defaults to the admin associated with the access token.
34093411
example: '991267583'
34103412
examples:
34113413
successful_response:
34123414
summary: Successful response
34133415
value:
3414-
company_id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3415-
admin_id: '991267583'
34163416
body: Hello
3417+
admin_id: '991267583'
34173418
admin_not_found:
34183419
summary: Admin not found
34193420
value:
3420-
company_id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3421-
admin_id: '123'
34223421
body: Hello
3422+
admin_id: '123'
34233423
company_not_found:
34243424
summary: Company not found
34253425
value:
3426-
company_id: '123'
3427-
admin_id: '991267583'
34283426
body: Hello
34293427
"/companies/list":
34303428
post:

0 commit comments

Comments
 (0)