From 2cca38bfa1ff80af6b57d8e160934d598443b4ff Mon Sep 17 00:00:00 2001
From: Stefaan Lippens <stefaan.lippens@vito.be>
Date: Thu, 2 May 2024 12:29:30 +0200
Subject: [PATCH] Add "OpenEO-Identifier" header to synchronous processing
 response

---
 CHANGELOG.md | 3 ++-
 openapi.yaml | 5 +++++
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index fdd0e0eb..56fa64a1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,10 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- `GET /file_formats`: Base paramater on top of normal JSON Schema, not Process JSON Schema
+- `GET /file_formats`: Base parameter on top of normal JSON Schema, not Process JSON Schema
 - `PATCH /services/{service_id}` and `PATCH /jobs/{job_id}`: Explicitly allow updating back-end specific properties (as in `POST`)
 - `GET /services/{service_id}` and `GET /jobs/{job_id}`: Explicitly allow listing back-end specific properties (as provided in `POST`)
 - Clarified for log levels which default values apply
+- `POST /result`: Standardize response header "OpenEO-Identifier" to expose a (correlation) identifier associated with a synchronous processing request.
 
 ## [1.2.0] - 2021-05-25
 
diff --git a/openapi.yaml b/openapi.yaml
index bf98aec3..d35148dc 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -2250,6 +2250,11 @@ paths:
               description: MAY include the costs for processing and downloading the data.
               schema:
                 $ref: '#/components/schemas/money'
+            OpenEO-Identifier:
+              description: Identifier associated with the synchronous processing request.
+              type: string
+              pattern: '^[\w\-\.~]+$'
+              example: a3cca2b2aa1e3b5b
             Link:
               description: >-
                 The header MAY indicate a link to a log file generated by the request. If provided, the link MUST be serialized according to [RFC 8288](https://www.rfc-editor.org/rfc/rfc8288.html#section-3) and MUST use the relation type `monitor`. The link MUST follow the specifications for the links `GET /jobs/{job_id}/logs` and `GET /services/{service_id}/logs`, except that is MUST NOT accept any parameters (limit/offset). Therefore, the link MUST be accessible with HTTP GET, MUST be secured using a Bearer token and MUST follow the corresponding request body schema.