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.
This commit is contained in:
Sybren A. Stüvel 2024-09-30 11:24:21 +02:00
parent 131b7c719c
commit 8d339b1528

View File

@ -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