Browse Source

Document End user optional header

Documentation for Optional Header X-End-User added
as part of Client ID logging requirement.

Change-Id: I3b2f201c60b8c4b45160b546841dce39c68dd21a
Smruti Soumitra Khuntia 1 month ago
parent
commit
b2b3abb1a9
1 changed files with 5 additions and 0 deletions
  1. 5
    0
      doc/source/api-conventions.rst

+ 5
- 0
doc/source/api-conventions.rst View File

@@ -119,6 +119,11 @@ X-Context-Marker
119 119
   marker. This marker may only be a 36-character canonical representation of an
120 120
   UUID (8-4-4-4-12)
121 121
 
122
+X-End-User
123
+  The user name of the initial invoker that will be carried on all logs for
124
+  user tracing cross components. Shipyard doesn't support this header and when
125
+  passed, it will be ignored.
126
+
122 127
 Validation API
123 128
 --------------
124 129
 All Airship components that participate in validation of the design supplied to

Loading…
Cancel
Save