Skip to content

Commit ea19b01

Browse files
authored
Update unstable open api doc (#237)
1 parent 2d989c9 commit ea19b01

File tree

1 file changed

+17
-26
lines changed

1 file changed

+17
-26
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11606,12 +11606,15 @@ paths:
1160611606
examples:
1160711607
Successful response:
1160811608
value:
11609-
type: enqueue_status
11610-
status: success
11611-
job_id: 20
11612-
job_url: https://api.intercom.io/jobs/status/20
11609+
type: job
11610+
id: "20"
11611+
status: pending
11612+
url: https://api.intercom.io/jobs/status/20
11613+
resource_type: ticket
11614+
resource_id: null
11615+
resource_url: null
1161311616
schema:
11614-
"$ref": "#/components/schemas/enqueue_status"
11617+
"$ref": "#/components/schemas/jobs"
1161511618
'401':
1161611619
description: Unauthorized
1161711620
content:
@@ -17306,23 +17309,6 @@ components:
1730617309
required:
1730717310
- type
1730817311
- errors
17309-
enqueue_status:
17310-
title: Enqueue status
17311-
type: object
17312-
description: Details of the job that was enqueued.
17313-
properties:
17314-
status:
17315-
type: string
17316-
description: Indicates if the job was successfully enqueued. The status can be either 'success' or 'failed'.
17317-
example: success
17318-
job_id:
17319-
type: string
17320-
description: Id of the job that was enqueued.
17321-
example: 20
17322-
job_url:
17323-
type: string
17324-
description: API endpoint URL to check the job status.
17325-
example: https://api.intercom.io/jobs/status/20
1732617312
external_page:
1732717313
title: External Page
1732817314
type: object
@@ -17696,11 +17682,14 @@ components:
1769617682
description: The type of the object
1769717683
enum:
1769817684
- job
17699-
example: job
1770017685
id:
1770117686
type: string
1770217687
description: The id of the job that's currently being processed or has completed.
17703-
example: success
17688+
example: 20
17689+
url:
17690+
type: string
17691+
description: API endpoint URL to check the job status.
17692+
example: https://api.intercom.io/jobs/status/20
1770417693
status:
1770517694
type: string
1770617695
description: The status of the job execution.
@@ -17715,11 +17704,13 @@ components:
1771517704
resource_id:
1771617705
type: string
1771717706
description: The id of the resource created during job execution (e.g. ticket id)
17718-
example: 20
17707+
example: 123
17708+
nullable: true
1771917709
resource_url:
1772017710
type: string
1772117711
description: The url of the resource created during job exeuction. Use this url to fetch the resource.
17722-
example: http://api.intercom.io/tickets/20
17712+
example: http://api.intercom.io/tickets/123
17713+
nullable: true
1772317714
required:
1772417715
- id
1772517716
intercom_version:

0 commit comments

Comments
 (0)