)]}'
{"guidelines/headers.rst":[{"author":{"_account_id":12000,"name":"Ian Cordasco","email":"sigmavirus24@gmail.com","username":"sigmavirus24"},"change_message_id":"b36b1d3e08216dd8ae4fbe6955b82e13e22c1b3e","unresolved":false,"context_lines":[{"line_number":13,"context_line":"------------------------------"},{"line_number":14,"context_line":""},{"line_number":15,"context_line":"In :rfc:`6648` the recommendation to prefix application-specific headers with"},{"line_number":16,"context_line":"``X-`` was retracted. It is mentioned in :rfc:`2616` as a permanently-reserved"},{"line_number":17,"context_line":"prefix for implementors, but is deprecated due to the complexities of migrating"},{"line_number":18,"context_line":"prefixed headers to standardized ones. This has resulted in some standards"},{"line_number":19,"context_line":"reserving X-prefixed names in addition to their non-prefixed headers. (see"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7a016987_71067f1d","line":16,"updated":"2015-05-28 21:01:29.000000000","message":"+1","commit_id":"4a4fbd6563eb6b2d8e80d749d7d1f4e508be9e02"},{"author":{"_account_id":12321,"name":"Ryan Brown","email":"rybrown@redhat.com","username":"ryansb"},"change_message_id":"758f4193214e2ca37c95100b9597420ec0035bda","unresolved":false,"context_lines":[{"line_number":13,"context_line":"------------------------------"},{"line_number":14,"context_line":""},{"line_number":15,"context_line":"In :rfc:`6648` the recommendation to prefix application-specific headers with"},{"line_number":16,"context_line":"``X-`` was retracted. It is mentioned in :rfc:`2616` as a permanently-reserved"},{"line_number":17,"context_line":"prefix for implementors, but is deprecated due to the complexities of migrating"},{"line_number":18,"context_line":"prefixed headers to standardized ones. This has resulted in some standards"},{"line_number":19,"context_line":"reserving X-prefixed names in addition to their non-prefixed headers. (see"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7a016987_c95b3185","line":16,"updated":"2015-05-29 12:59:48.000000000","message":"Actually 7231 doesn\u0027t require the X- prefix. This was mostly a history thing, but I\u0027ll put the reference to the newer RFC and note that it doesn\u0027t suggest X- for new fields.","commit_id":"4a4fbd6563eb6b2d8e80d749d7d1f4e508be9e02"},{"author":{"_account_id":330,"name":"John Dickinson","email":"me@not.mn","username":"notmyname"},"change_message_id":"618ef1ceab762738d4f93ecefe609219aaf8adea","unresolved":false,"context_lines":[{"line_number":13,"context_line":"------------------------------"},{"line_number":14,"context_line":""},{"line_number":15,"context_line":"In :rfc:`6648` the recommendation to prefix application-specific headers with"},{"line_number":16,"context_line":"``X-`` was retracted. It is mentioned in :rfc:`2616` as a permanently-reserved"},{"line_number":17,"context_line":"prefix for implementors, but is deprecated due to the complexities of migrating"},{"line_number":18,"context_line":"prefixed headers to standardized ones. This has resulted in some standards"},{"line_number":19,"context_line":"reserving X-prefixed names in addition to their non-prefixed headers. (see"}],"source_content_type":"text/x-rst","patch_set":3,"id":"7a016987_f30a7725","line":16,"updated":"2015-05-28 20:41:59.000000000","message":"You should reference RFC 7231, section 8.3.1 instead of 2616.","commit_id":"4a4fbd6563eb6b2d8e80d749d7d1f4e508be9e02"},{"author":{"_account_id":1112,"name":"Everett Toews","email":"everett.toews@rackspace.com","username":"everett-toews"},"change_message_id":"3b1160992c94d2ee0c1a9d2fdfbff4565cff4437","unresolved":false,"context_lines":[{"line_number":28,"context_line":"should make their best effort to not use header names that conflict with other"},{"line_number":29,"context_line":"applications. The simplest way to do this is to use a project name or similar"},{"line_number":30,"context_line":"in the header. An example might be \"Swift-Container-ACL\", which is unlikely to"},{"line_number":31,"context_line":"be standardized for another project or conflict with an existing header."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":":rfc:`6648` intentionally does not disallow using \"X\" as a prefix, but does"},{"line_number":34,"context_line":"remove the experimental/unstandardized semantics from the prefix. For"}],"source_content_type":"text/x-rst","patch_set":4,"id":"ba3cc151_5d8b251f","line":31,"updated":"2015-07-02 17:16:38.000000000","message":"I really think we should strongly recommend prefixing all OpenStack APIs that use a custom header with \"OpenStack-\". It\u0027s our namespace so let\u0027s use it.","commit_id":"2c0176a0386f428704b1f70e17abc524f94014d1"},{"author":{"_account_id":261,"name":"Salvatore Orlando","email":"salv.orlando@gmail.com","username":"salvatore-orlando"},"change_message_id":"10a206581b47d300bfc8e1b525560a2994821bed","unresolved":false,"context_lines":[{"line_number":28,"context_line":"should make their best effort to not use header names that conflict with other"},{"line_number":29,"context_line":"applications. The simplest way to do this is to use a project name or similar"},{"line_number":30,"context_line":"in the header. An example might be \"Swift-Container-ACL\", which is unlikely to"},{"line_number":31,"context_line":"be standardized for another project or conflict with an existing header."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":":rfc:`6648` intentionally does not disallow using \"X\" as a prefix, but does"},{"line_number":34,"context_line":"remove the experimental/unstandardized semantics from the prefix. For"}],"source_content_type":"text/x-rst","patch_set":4,"id":"3a50d1a3_8dbf5160","line":31,"in_reply_to":"9a41bdd9_415e8046","updated":"2015-07-22 23:13:45.000000000","message":"I think the guidance can be satisfied by recommending using the project name. If the specific project needs deeper level of detailing that\u0027s fine and does not violate the guideline.","commit_id":"2c0176a0386f428704b1f70e17abc524f94014d1"},{"author":{"_account_id":10348,"name":"Maish Saidel-Keesing","email":"maishsk@gmail.com","username":"maishsk"},"change_message_id":"1d689221e3f96710b959be600ab2c203dcf64c35","unresolved":false,"context_lines":[{"line_number":28,"context_line":"should make their best effort to not use header names that conflict with other"},{"line_number":29,"context_line":"applications. The simplest way to do this is to use a project name or similar"},{"line_number":30,"context_line":"in the header. An example might be \"Swift-Container-ACL\", which is unlikely to"},{"line_number":31,"context_line":"be standardized for another project or conflict with an existing header."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":":rfc:`6648` intentionally does not disallow using \"X\" as a prefix, but does"},{"line_number":34,"context_line":"remove the experimental/unstandardized semantics from the prefix. For"}],"source_content_type":"text/x-rst","patch_set":4,"id":"9a41bdd9_415e8046","line":31,"in_reply_to":"ba3cc151_55f5d580","updated":"2015-07-17 12:12:17.000000000","message":"Is the project name sufficient? What about multiple components (such as Neutron-XYZ). \n\nJust something to think about.","commit_id":"2c0176a0386f428704b1f70e17abc524f94014d1"},{"author":{"_account_id":12321,"name":"Ryan Brown","email":"rybrown@redhat.com","username":"ryansb"},"change_message_id":"9efb28f2b629dc57de60c8e98d6df72b364c29f8","unresolved":false,"context_lines":[{"line_number":28,"context_line":"should make their best effort to not use header names that conflict with other"},{"line_number":29,"context_line":"applications. The simplest way to do this is to use a project name or similar"},{"line_number":30,"context_line":"in the header. An example might be \"Swift-Container-ACL\", which is unlikely to"},{"line_number":31,"context_line":"be standardized for another project or conflict with an existing header."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":":rfc:`6648` intentionally does not disallow using \"X\" as a prefix, but does"},{"line_number":34,"context_line":"remove the experimental/unstandardized semantics from the prefix. For"}],"source_content_type":"text/x-rst","patch_set":4,"id":"ba3cc151_b5a0e1a6","line":31,"in_reply_to":"ba3cc151_5d8b251f","updated":"2015-07-06 17:29:23.000000000","message":"I think OS-\u003cproject\u003e-Foo would be a good prefix, so no project stomps on any other ones. \n\nI *don\u0027t* know whether the project name or the generic name would be correct for this purpose. I imagine the generic (Compute, etc) would be the way to go here.","commit_id":"2c0176a0386f428704b1f70e17abc524f94014d1"},{"author":{"_account_id":12321,"name":"Ryan Brown","email":"rybrown@redhat.com","username":"ryansb"},"change_message_id":"440bf8dc76853bcf3317501c9458f838e8bb41d9","unresolved":false,"context_lines":[{"line_number":28,"context_line":"should make their best effort to not use header names that conflict with other"},{"line_number":29,"context_line":"applications. The simplest way to do this is to use a project name or similar"},{"line_number":30,"context_line":"in the header. An example might be \"Swift-Container-ACL\", which is unlikely to"},{"line_number":31,"context_line":"be standardized for another project or conflict with an existing header."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":":rfc:`6648` intentionally does not disallow using \"X\" as a prefix, but does"},{"line_number":34,"context_line":"remove the experimental/unstandardized semantics from the prefix. For"}],"source_content_type":"text/x-rst","patch_set":4,"id":"ba3cc151_55f5d580","line":31,"in_reply_to":"ba3cc151_b5a0e1a6","updated":"2015-07-06 17:32:53.000000000","message":"Correction: we should probably stick with the service name (Compute, Orchestration, etc) per https://review.openstack.org/#/c/196918/","commit_id":"2c0176a0386f428704b1f70e17abc524f94014d1"},{"author":{"_account_id":6486,"name":"Brant Knudson","email":"blk@acm.org","username":"blk-u"},"change_message_id":"dced4a6c55bdd7f3022b74b405c609f8c832e43b","unresolved":false,"context_lines":[{"line_number":50,"context_line":""},{"line_number":51,"context_line":"  Account-ID"},{"line_number":52,"context_line":"  Host-Name"},{"line_number":53,"context_line":"  Storage-Policy"}],"source_content_type":"text/x-rst","patch_set":4,"id":"3a50d1a3_64a0e242","line":53,"updated":"2015-07-28 21:29:18.000000000","message":"I\u0027d like to see some examples for suggestions for some existing common headers. For example, what should we change X-Auth-Token and X-Service-Token to?","commit_id":"2c0176a0386f428704b1f70e17abc524f94014d1"},{"author":{"_account_id":12321,"name":"Ryan Brown","email":"rybrown@redhat.com","username":"ryansb"},"change_message_id":"5d2c9cabc1d6ac689c265b0cc208ef834aa6d203","unresolved":false,"context_lines":[{"line_number":50,"context_line":""},{"line_number":51,"context_line":"  Account-ID"},{"line_number":52,"context_line":"  Host-Name"},{"line_number":53,"context_line":"  Storage-Policy"}],"source_content_type":"text/x-rst","patch_set":4,"id":"1a4dcd0f_2d3994f2","line":53,"in_reply_to":"3a50d1a3_64a0e242","updated":"2015-08-05 16:17:44.000000000","message":"So the idea isn\u0027t to change headers that exist already (see line 25). I believe for crossproject headers the best way to go would be to use \"OpenStack-\" as a prefix (in examples above).","commit_id":"2c0176a0386f428704b1f70e17abc524f94014d1"},{"author":{"_account_id":7,"name":"Jay Pipes","email":"jaypipes@gmail.com","username":"jaypipes"},"change_message_id":"71ffd547ebcf76cbc10da9a6d02bc4c2c74b93c8","unresolved":false,"context_lines":[{"line_number":28,"context_line":"features) should make their best effort to not use header names that conflict"},{"line_number":29,"context_line":"with other applications. The simplest way to do this is to use either"},{"line_number":30,"context_line":"OpenStack, the service name, or both in the header. An example might be"},{"line_number":31,"context_line":"\"OpenStack-Auth\" or \"Compute-FooBar\", which are unlikely to be standardized"},{"line_number":32,"context_line":"already or conflict with existing headers."},{"line_number":33,"context_line":""},{"line_number":34,"context_line":":rfc:`6648` intentionally does not disallow using ``X-`` as a prefix, but does"}],"source_content_type":"text/x-rst","patch_set":6,"id":"1a4dcd0f_8cb15803","line":31,"updated":"2015-08-13 15:42:13.000000000","message":"Technically, Keystone\u0027s service name is \"identity\", not \"auth\", IIRC :)","commit_id":"21a39d3fa45cd4a6db78325f0b126e28d9a5bdea"},{"author":{"_account_id":4,"name":"Dolph Mathews","email":"dolph.mathews@gmail.com","username":"dolph"},"change_message_id":"2418a957b413686844a7c66c15c601eea535fb0b","unresolved":false,"context_lines":[{"line_number":28,"context_line":"features) should make their best effort to not use header names that conflict"},{"line_number":29,"context_line":"with other applications. The simplest way to do this is to use either"},{"line_number":30,"context_line":"OpenStack, the service name, or both in the header. An example might be"},{"line_number":31,"context_line":"\"OpenStack-Auth\" or \"Compute-FooBar\", which are unlikely to be standardized"},{"line_number":32,"context_line":"already or conflict with existing headers."},{"line_number":33,"context_line":""},{"line_number":34,"context_line":":rfc:`6648` intentionally does not disallow using ``X-`` as a prefix, but does"}],"source_content_type":"text/x-rst","patch_set":6,"id":"1a4dcd0f_95b34f4d","line":31,"in_reply_to":"1a4dcd0f_8cb15803","updated":"2015-08-14 23:50:48.000000000","message":"++","commit_id":"21a39d3fa45cd4a6db78325f0b126e28d9a5bdea"},{"author":{"_account_id":782,"name":"John Garbutt","email":"john@johngarbutt.com","username":"johngarbutt"},"change_message_id":"bad230ddf01a3e387ab41391cc8ec4499739be89","unresolved":false,"context_lines":[{"line_number":43,"context_line":"Some good header names that are clear, unlikely to conflict, and could become"},{"line_number":44,"context_line":"standardized might be::"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"  Instance-Image-ACL"},{"line_number":47,"context_line":"  OpenStack-Identity-Status"},{"line_number":48,"context_line":""},{"line_number":49,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"1a4dcd0f_67031943","line":46,"updated":"2015-08-12 09:14:36.000000000","message":"part of me still wants to add OpenStack to these, but I agree with the concept, I think.","commit_id":"21a39d3fa45cd4a6db78325f0b126e28d9a5bdea"},{"author":{"_account_id":1112,"name":"Everett Toews","email":"everett.toews@rackspace.com","username":"everett-toews"},"change_message_id":"8c15c7ff37bb0e08741eb4b6bb6eb20b34f2860d","unresolved":false,"context_lines":[{"line_number":43,"context_line":"Some good header names that are clear, unlikely to conflict, and could become"},{"line_number":44,"context_line":"standardized might be::"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"  Instance-Image-ACL"},{"line_number":47,"context_line":"  OpenStack-Identity-Status"},{"line_number":48,"context_line":""},{"line_number":49,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"1a4dcd0f_db3c2695","line":46,"in_reply_to":"1a4dcd0f_67031943","updated":"2015-08-12 18:56:34.000000000","message":"Hmmmm...I know what you mean. I\u0027m trying to think of a reason we wouldn\u0027t want to recommend prefixing everything with OpenStack-. Conceivably we should be able to guarantee anything OpenStack- prefixed *will not* conflict, rather than the less strong \"unlikely to conflict\" above.\n\n@Ryan Is there a reason we\u0027re not recommending prefixing everything with OpenStack- ?","commit_id":"21a39d3fa45cd4a6db78325f0b126e28d9a5bdea"},{"author":{"_account_id":7,"name":"Jay Pipes","email":"jaypipes@gmail.com","username":"jaypipes"},"change_message_id":"71ffd547ebcf76cbc10da9a6d02bc4c2c74b93c8","unresolved":false,"context_lines":[{"line_number":43,"context_line":"Some good header names that are clear, unlikely to conflict, and could become"},{"line_number":44,"context_line":"standardized might be::"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"  Instance-Image-ACL"},{"line_number":47,"context_line":"  OpenStack-Identity-Status"},{"line_number":48,"context_line":""},{"line_number":49,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"1a4dcd0f_ecba5cbf","line":46,"in_reply_to":"1a4dcd0f_db3c2695","updated":"2015-08-13 15:42:13.000000000","message":"Agree with John that a recommendation to prefix everything with OpenStack- would be beneficial here.","commit_id":"21a39d3fa45cd4a6db78325f0b126e28d9a5bdea"}]}