)]}'
{"api-ref/source/allocations.inc":[{"author":{"_account_id":14070,"name":"Eric Fried","email":"openstack@fried.cc","username":"efried"},"change_message_id":"83d5b3600707212f402c7ae42ecb5e1084062adf","unresolved":false,"context_lines":[{"line_number":74,"context_line":"List all allocation records for the consumer identified by"},{"line_number":75,"context_line":"`{consumer_uuid}` on all the resource providers it is consuming."},{"line_number":76,"context_line":""},{"line_number":77,"context_line":".. note:: When listing allocations for a consumer uuid that has no"},{"line_number":78,"context_line":"          allocations a dict with an empty value is returned"},{"line_number":79,"context_line":"          ``{\"allocations\": {}}``."},{"line_number":80,"context_line":""},{"line_number":81,"context_line":".. rest_method:: GET /allocations/{consumer_uuid}"},{"line_number":82,"context_line":""}],"source_content_type":"text/x-c++src","patch_set":1,"id":"3fa7e38b_e6ebcca0","line":79,"range":{"start_line":77,"start_character":0,"end_line":79,"end_character":34},"updated":"2019-10-16 18:45:14.000000000","message":"borrowed the wording from here...","commit_id":"6819e7360963a0c3149ec1afdd1595dc52798c72"}],"api-ref/source/parameters.yaml":[{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"7666a2abc449e1eaa944c509825a70b57e7613b2","unresolved":false,"context_lines":[{"line_number":478,"context_line":"  description: \u003e"},{"line_number":479,"context_line":"    The generation of the consumer. Should be set to ``null`` when indicating"},{"line_number":480,"context_line":"    that the caller expects the consumer does not yet exist."},{"line_number":481,"context_line":"consumer_generation_get:"},{"line_number":482,"context_line":"  \u003c\u003c: *consumer_generation"},{"line_number":483,"context_line":"  description: \u003e"},{"line_number":484,"context_line":"    The generation of the consumer. Will be absent when listing allocations for"}],"source_content_type":"text/x-yaml","patch_set":1,"id":"3fa7e38b_cc47d14b","line":481,"updated":"2019-10-16 19:59:37.000000000","message":"So don\u0027t we usually mark a parameter as required: false if it\u0027s optionally not going to show up in the response body dict? If so, shouldn\u0027t this and the user_id/project_id ones below also be required: false? I know it\u0027s a bit weird semantically since it\u0027s based on some internal state stuff rather than, for example, a microversion, but technically they are \"optional\" in the response regardless of using 1.28+.","commit_id":"6819e7360963a0c3149ec1afdd1595dc52798c72"},{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"b8232a9bf7789e2c325fa44735313b4a1ed688fc","unresolved":false,"context_lines":[{"line_number":478,"context_line":"  description: \u003e"},{"line_number":479,"context_line":"    The generation of the consumer. Should be set to ``null`` when indicating"},{"line_number":480,"context_line":"    that the caller expects the consumer does not yet exist."},{"line_number":481,"context_line":"consumer_generation_get:"},{"line_number":482,"context_line":"  \u003c\u003c: *consumer_generation"},{"line_number":483,"context_line":"  description: \u003e"},{"line_number":484,"context_line":"    The generation of the consumer. Will be absent when listing allocations for"}],"source_content_type":"text/x-yaml","patch_set":1,"id":"3fa7e38b_6c849d0b","line":481,"in_reply_to":"3fa7e38b_acd7f522","updated":"2019-10-16 20:24:07.000000000","message":"Yeah that\u0027s the weird semantics I was talking about, but that\u0027s the case for things that don\u0027t get returned in certain situations, meaning the caller has to be aware the key might not be in the response dict. Anyway, I think that\u0027s what we do in nova, e.g. the \u0027servers\u0027 response parameter for GET /os-hypervisors:\n\nhttps://docs.openstack.org/api-ref/compute/?expanded\u003dshow-hypervisor-details-detail#show-hypervisor-details\n\nIt\u0027s definitely more confusing in a response parameter than a request parameter, and looking at placement API references where required\u003dfalse I only see it used in request parameters so I won\u0027t rock the boat.","commit_id":"6819e7360963a0c3149ec1afdd1595dc52798c72"},{"author":{"_account_id":14070,"name":"Eric Fried","email":"openstack@fried.cc","username":"efried"},"change_message_id":"deb979427e28c75c1b8a1fbf11ea3acfc798e032","unresolved":false,"context_lines":[{"line_number":478,"context_line":"  description: \u003e"},{"line_number":479,"context_line":"    The generation of the consumer. Should be set to ``null`` when indicating"},{"line_number":480,"context_line":"    that the caller expects the consumer does not yet exist."},{"line_number":481,"context_line":"consumer_generation_get:"},{"line_number":482,"context_line":"  \u003c\u003c: *consumer_generation"},{"line_number":483,"context_line":"  description: \u003e"},{"line_number":484,"context_line":"    The generation of the consumer. Will be absent when listing allocations for"}],"source_content_type":"text/x-yaml","patch_set":1,"id":"3fa7e38b_acd7f522","line":481,"in_reply_to":"3fa7e38b_cc47d14b","updated":"2019-10-16 20:11:44.000000000","message":"I actually tried that and took it out because with required:false the table cell gets \"(Optional)\" added, which IMO reads weird, whereas with required:true it\u0027s undecorated. If in the latter case it showed e.g. \"(Required)\" I would agree it should be the other way around.","commit_id":"6819e7360963a0c3149ec1afdd1595dc52798c72"},{"author":{"_account_id":14070,"name":"Eric Fried","email":"openstack@fried.cc","username":"efried"},"change_message_id":"83d5b3600707212f402c7ae42ecb5e1084062adf","unresolved":false,"context_lines":[{"line_number":481,"context_line":"consumer_generation_get:"},{"line_number":482,"context_line":"  \u003c\u003c: *consumer_generation"},{"line_number":483,"context_line":"  description: \u003e"},{"line_number":484,"context_line":"    The generation of the consumer. Will be absent when listing allocations for"},{"line_number":485,"context_line":"    a consumer uuid that has no allocations."},{"line_number":486,"context_line":"  min_version: 1.28"},{"line_number":487,"context_line":"consumer_generation_min:"},{"line_number":488,"context_line":"  \u003c\u003c: *consumer_generation"}],"source_content_type":"text/x-yaml","patch_set":1,"id":"3fa7e38b_a62f14f4","line":485,"range":{"start_line":484,"start_character":56,"end_line":485,"end_character":43},"updated":"2019-10-16 18:45:14.000000000","message":"...to use here.\n\nditto below.","commit_id":"6819e7360963a0c3149ec1afdd1595dc52798c72"}]}