From 8d339b1528a0ce3174536ede99a338fddf55b48f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Mon, 30 Sep 2024 11:24:21 +0200 Subject: [PATCH] OAPI: document encoding of the `X-Shaman-Original-Filename` header Document that the `X-Shaman-Original-Filename` HTTP header (used when submitting files to the Shaman server) should either be ASCII or encoded using RFC 2047. No functional changes. --- pkg/api/flamenco-openapi.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pkg/api/flamenco-openapi.yaml b/pkg/api/flamenco-openapi.yaml index 975567fc..7886d3d3 100644 --- a/pkg/api/flamenco-openapi.yaml +++ b/pkg/api/flamenco-openapi.yaml @@ -1324,7 +1324,9 @@ paths: schema: { type: string } description: > The original filename. If sent along with the request, it will be - included in the server logs, which can aid in debugging. + included in the server logs, which can aid in debugging. MUST either + be ASCII or encoded using RFC 2047 (aka MIME encoding). In the + latter case the encoding MUST be UTF-8. requestBody: description: Contents of the file required: true