cta-wave / common-media-client-data

A repository to collect discussion and feedback on the Common Media Client Data proposal.
30 stars 0 forks source link

Organize Reserved Keys section of document by Header Name instead of alphabetical for all keys #111

Closed glenng1215gh closed 5 months ago

glenng1215gh commented 1 year ago

The document may read easier if the Reserved Keys section had a separate table for each of the 4 Header Names: CMCD-Request CMCD-Object CMCD-Status CMCD-Session

This would help emphasis the importance of these scoping constructs (request vs session, for example)

PCaponetti commented 5 months ago

We will re-organize the document by header name. Once done, we can mark this complete.

wilaw commented 5 months ago

Actually I'm not a fan or organizing by header for the following reasons:

  1. That breakdown would not make sense for Query ARG of JSON based reporting , which does not use headers.
  2. More often than not, I am scanning the table looking for the definition of a particular key. It is far easier and faster to do that in alphabetic order than by scanning 4 tables and having to remember which key goes with which header.
PCaponetti commented 5 months ago

In group meeting, consensus achieved that given the comments above we will preserve a single table with alphabetical order.

Not opposed to making the document more readable, but not convinced that sharding by header is the right way.