Document segments API available headers in OpenAPI

• Type: Task
• Status: In Review
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: None
• Fix Version/s: None
• Component/s: Segmentation
• Labels:
  • fc_19_10
• Epic/Theme:
  • Segmentation
• Epic Link: tango-dev-exp-using-sp-headless
• Sprint: TANGO | SP_21 | Oct02-Oct16
• Git Pull Request: https://github.com/brianchandotcom/liferay-portal/pull/79231

We want to document the available header that a user can use in the API to retrieve segments.

These are the available headers:

• Host (internal note: this is going to map with Context.URL)
• Accept-Language (internal note: this is going to map with Context.LANGUAGE_ID)
• User-Agent (internal note: this is going to map with Context.USER_AGENT)
• X-Browser (internal note: this is going to map with Context.BROWSER)
• X-Cookies (internal note: this is going to map with Context.COOKIES)
• X-Device-Brand (internal note: this is going to map with Context.DEVICE_BRAND)
• X-Device-Model (internal note: this is going to map with Context.DEVICE_MODEL)
• X-Device-Screen-Resolution-Height (internal note: this is going to map with Context.DEVICE_SCREEN_RESOLUTION_HEIGHT)
• X-Device-Screen-Resolution-Width (internal note: this is going to map with Context.DEVICE_SCREEN_RESOLUTION_WIDTH)
• X-Last-Sign-In-Date-Time (internal note: this is going to map with Context.LAST_SIGN_IN_DATE_TIME)
• X-Signed-In (internal note: this is going to map with Context.SIGNED_IN)
• (internal note: Context.LOCAL_DATE is always present in the context)

To complete this task: https://swagger.io/docs/specification/describing-parameters/?origin_team=T03BTCQAJ#header-parameters