Skip to content

Update unstable open api doc #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 17 additions & 26 deletions descriptions/0/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11606,12 +11606,15 @@ paths:
examples:
Successful response:
value:
type: enqueue_status
status: success
job_id: 20
job_url: https://api.intercom.io/jobs/status/20
type: job
id: "20"
status: pending
url: https://api.intercom.io/jobs/status/20
resource_type: ticket
resource_id: null
resource_url: null
schema:
"$ref": "#/components/schemas/enqueue_status"
"$ref": "#/components/schemas/jobs"
'401':
description: Unauthorized
content:
Expand Down Expand Up @@ -17306,23 +17309,6 @@ components:
required:
- type
- errors
enqueue_status:
title: Enqueue status
type: object
description: Details of the job that was enqueued.
properties:
status:
type: string
description: Indicates if the job was successfully enqueued. The status can be either 'success' or 'failed'.
example: success
job_id:
type: string
description: Id of the job that was enqueued.
example: 20
job_url:
type: string
description: API endpoint URL to check the job status.
example: https://api.intercom.io/jobs/status/20
external_page:
title: External Page
type: object
Expand Down Expand Up @@ -17696,11 +17682,14 @@ components:
description: The type of the object
enum:
- job
example: job
id:
type: string
description: The id of the job that's currently being processed or has completed.
example: success
example: 20
url:
type: string
description: API endpoint URL to check the job status.
example: https://api.intercom.io/jobs/status/20
status:
type: string
description: The status of the job execution.
Expand All @@ -17715,11 +17704,13 @@ components:
resource_id:
type: string
description: The id of the resource created during job execution (e.g. ticket id)
example: 20
example: 123
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change this to be different from the job id to better distinguish between the two

nullable: true
resource_url:
type: string
description: The url of the resource created during job exeuction. Use this url to fetch the resource.
example: http://api.intercom.io/tickets/20
example: http://api.intercom.io/tickets/123
nullable: true
required:
- id
intercom_version:
Expand Down