Skip to content

Commit b7e4dd4

Browse files
authored
Enhance API documentation for export job data download (#307)
* 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. * Fix indentation * Add example
1 parent d450b1f commit b7e4dd4

File tree

5 files changed

+41
-2
lines changed

5 files changed

+41
-2
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1741,12 +1741,27 @@ paths:
17411741
"/download/reporting_data/{job_identifier}":
17421742
get:
17431743
summary: Download completed export job data
1744+
description: |
1745+
Download the data from a completed reporting data export job.
1746+
1747+
> Octet header required
1748+
>
1749+
> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.
17441750
tags: [Export]
17451751
parameters:
17461752
- name: Intercom-Version
17471753
in: header
17481754
schema:
17491755
"$ref": "#/components/schemas/intercom_version"
1756+
- name: Accept
1757+
in: header
1758+
required: true
1759+
schema:
1760+
type: string
1761+
example: application/octet-stream
1762+
enum:
1763+
- application/octet-stream
1764+
description: "Required header for downloading the export file"
17501765
- name: app_id
17511766
in: query
17521767
required: true

descriptions/2.14/api.intercom.io.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1741,12 +1741,27 @@ paths:
17411741
"/download/reporting_data/{job_identifier}":
17421742
get:
17431743
summary: Download completed export job data
1744+
description: |
1745+
Download the data from a completed reporting data export job.
1746+
1747+
> Octet header required
1748+
>
1749+
> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.
17441750
tags: [Export]
17451751
parameters:
17461752
- name: Intercom-Version
17471753
in: header
17481754
schema:
17491755
"$ref": "#/components/schemas/intercom_version"
1756+
- name: Accept
1757+
in: header
1758+
required: true
1759+
schema:
1760+
type: string
1761+
example: application/octet-stream
1762+
enum:
1763+
- application/octet-stream
1764+
description: "Required header for downloading the export file"
17501765
- name: app_id
17511766
in: query
17521767
required: true

fern/openapi-overrides.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,15 @@ 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+
example: application/octet-stream
778+
enum:
779+
- application/octet-stream
780+
description: "Required header for downloading the export file"
772781
- name: app_id
773782
in: query
774783
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)