From 64518b2b53e0cf2067b6fdd18956774627a8d2af Mon Sep 17 00:00:00 2001 From: Stephen Sunday Date: Tue, 16 Sep 2025 01:27:21 +0100 Subject: [PATCH 1/3] 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. --- descriptions/0/api.intercom.io.yaml | 13 +++++++++++++ descriptions/2.14/api.intercom.io.yaml | 13 +++++++++++++ fern/openapi-overrides.yml | 8 ++++++++ postman/2.14/intercom-api.postman_collection.json | 2 +- .../Unstable/intercom-api.postman_collection.json | 2 +- 5 files changed, 36 insertions(+), 2 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 084b17d..c62fb8c 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -1741,12 +1741,25 @@ paths: "/download/reporting_data/{job_identifier}": get: summary: Download completed export job data + Download the data from a completed reporting data export job. + + > Octet header required + > + > You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint. tags: [Export] parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" + - name: Accept + in: header + required: true + schema: + type: string + enum: + - application/octet-stream + description: "Required header for downloading the export file" - name: app_id in: query required: true diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 0faddaf..0e768a6 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -1741,12 +1741,25 @@ paths: "/download/reporting_data/{job_identifier}": get: summary: Download completed export job data + Download the data from a completed reporting data export job. + + > Octet header required + > + > You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint. tags: [Export] parameters: - name: Intercom-Version in: header schema: "$ref": "#/components/schemas/intercom_version" + - name: Accept + in: header + required: true + schema: + type: string + enum: + - application/octet-stream + description: "Required header for downloading the export file" - name: app_id in: query required: true diff --git a/fern/openapi-overrides.yml b/fern/openapi-overrides.yml index 227ebe7..72740c6 100644 --- a/fern/openapi-overrides.yml +++ b/fern/openapi-overrides.yml @@ -769,6 +769,14 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" + - name: Accept + in: header + required: true + schema: + type: string + enum: + - application/octet-stream + description: "Required header for downloading the export file" - name: app_id in: query required: true diff --git a/postman/2.14/intercom-api.postman_collection.json b/postman/2.14/intercom-api.postman_collection.json index 3205030..411581e 100644 --- a/postman/2.14/intercom-api.postman_collection.json +++ b/postman/2.14/intercom-api.postman_collection.json @@ -9320,7 +9320,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "application/octet-stream" } ], "body": null diff --git a/postman/Unstable/intercom-api.postman_collection.json b/postman/Unstable/intercom-api.postman_collection.json index 0313cc5..7cb04ee 100644 --- a/postman/Unstable/intercom-api.postman_collection.json +++ b/postman/Unstable/intercom-api.postman_collection.json @@ -9787,7 +9787,7 @@ }, { "key": "Accept", - "value": "application/json" + "value": "application/octet-stream" } ], "body": null From 124d17d9a9da828c4b81f2184e3e2670638636df Mon Sep 17 00:00:00 2001 From: Stephen Sunday Date: Tue, 16 Sep 2025 02:12:09 +0100 Subject: [PATCH 2/3] Fix indentation --- descriptions/0/api.intercom.io.yaml | 1 + descriptions/2.14/api.intercom.io.yaml | 1 + 2 files changed, 2 insertions(+) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index c62fb8c..ee99c3b 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -1741,6 +1741,7 @@ paths: "/download/reporting_data/{job_identifier}": get: summary: Download completed export job data + description: | Download the data from a completed reporting data export job. > Octet header required diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 0e768a6..4cb3425 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -1741,6 +1741,7 @@ paths: "/download/reporting_data/{job_identifier}": get: summary: Download completed export job data + description: | Download the data from a completed reporting data export job. > Octet header required From 1aae77118a6ddd2048e34cc1686534750ba23117 Mon Sep 17 00:00:00 2001 From: Stephen Sunday Date: Tue, 16 Sep 2025 02:31:12 +0100 Subject: [PATCH 3/3] Add example --- descriptions/0/api.intercom.io.yaml | 1 + descriptions/2.14/api.intercom.io.yaml | 1 + fern/openapi-overrides.yml | 1 + 3 files changed, 3 insertions(+) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index ee99c3b..c6a9b41 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -1758,6 +1758,7 @@ paths: required: true schema: type: string + example: application/octet-stream enum: - application/octet-stream description: "Required header for downloading the export file" diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 4cb3425..cb53ef2 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -1758,6 +1758,7 @@ paths: required: true schema: type: string + example: application/octet-stream enum: - application/octet-stream description: "Required header for downloading the export file" diff --git a/fern/openapi-overrides.yml b/fern/openapi-overrides.yml index 72740c6..71a80f5 100644 --- a/fern/openapi-overrides.yml +++ b/fern/openapi-overrides.yml @@ -774,6 +774,7 @@ paths: required: true schema: type: string + example: application/octet-stream enum: - application/octet-stream description: "Required header for downloading the export file"