From b2b3abb1a951aa41eb4c16d1d7cef032ce458136 Mon Sep 17 00:00:00 2001 From: Smruti Soumitra Khuntia Date: Wed, 13 Mar 2019 16:15:31 +0530 Subject: [PATCH] Document End user optional header Documentation for Optional Header X-End-User added as part of Client ID logging requirement. Change-Id: I3b2f201c60b8c4b45160b546841dce39c68dd21a --- doc/source/api-conventions.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/source/api-conventions.rst b/doc/source/api-conventions.rst index cb7372ac..31d8e095 100644 --- a/doc/source/api-conventions.rst +++ b/doc/source/api-conventions.rst @@ -119,6 +119,11 @@ X-Context-Marker marker. This marker may only be a 36-character canonical representation of an UUID (8-4-4-4-12) +X-End-User + The user name of the initial invoker that will be carried on all logs for + user tracing cross components. Shipyard doesn't support this header and when + passed, it will be ignored. + Validation API -------------- All Airship components that participate in validation of the design supplied to