Skip to content

Commit 64518b2

Browse files
committed
Enhance API documentation for export job data download
- Added detailed description for the "/download/reporting_data/{job_identifier}" endpoint, specifying the requirement for the Accept header with value `application/octet-stream`. - Updated parameter definitions to include the Accept header as a required field for downloading export files.
1 parent d450b1f commit 64518b2

File tree

5 files changed

+36
-2
lines changed

5 files changed

+36
-2
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1741,12 +1741,25 @@ paths:
17411741
"/download/reporting_data/{job_identifier}":
17421742
get:
17431743
summary: Download completed export job data
1744+
Download the data from a completed reporting data export job.
1745+
1746+
> Octet header required
1747+
>
1748+
> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.
17441749
tags: [Export]
17451750
parameters:
17461751
- name: Intercom-Version
17471752
in: header
17481753
schema:
17491754
"$ref": "#/components/schemas/intercom_version"
1755+
- name: Accept
1756+
in: header
1757+
required: true
1758+
schema:
1759+
type: string
1760+
enum:
1761+
- application/octet-stream
1762+
description: "Required header for downloading the export file"
17501763
- name: app_id
17511764
in: query
17521765
required: true

descriptions/2.14/api.intercom.io.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1741,12 +1741,25 @@ paths:
17411741
"/download/reporting_data/{job_identifier}":
17421742
get:
17431743
summary: Download completed export job data
1744+
Download the data from a completed reporting data export job.
1745+
1746+
> Octet header required
1747+
>
1748+
> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.
17441749
tags: [Export]
17451750
parameters:
17461751
- name: Intercom-Version
17471752
in: header
17481753
schema:
17491754
"$ref": "#/components/schemas/intercom_version"
1755+
- name: Accept
1756+
in: header
1757+
required: true
1758+
schema:
1759+
type: string
1760+
enum:
1761+
- application/octet-stream
1762+
description: "Required header for downloading the export file"
17501763
- name: app_id
17511764
in: query
17521765
required: true

fern/openapi-overrides.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,14 @@ paths:
769769
in: header
770770
schema:
771771
"$ref": "#/components/schemas/intercom_version"
772+
- name: Accept
773+
in: header
774+
required: true
775+
schema:
776+
type: string
777+
enum:
778+
- application/octet-stream
779+
description: "Required header for downloading the export file"
772780
- name: app_id
773781
in: query
774782
required: true

postman/2.14/intercom-api.postman_collection.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9320,7 +9320,7 @@
93209320
},
93219321
{
93229322
"key": "Accept",
9323-
"value": "application/json"
9323+
"value": "application/octet-stream"
93249324
}
93259325
],
93269326
"body": null

postman/Unstable/intercom-api.postman_collection.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9787,7 +9787,7 @@
97879787
},
97889788
{
97899789
"key": "Accept",
9790-
"value": "application/json"
9790+
"value": "application/octet-stream"
97919791
}
97929792
],
97939793
"body": null

0 commit comments

Comments
 (0)