)]}'
{"/COMMIT_MSG":[{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"eaec31a5f7d0d9571a309e6810c01cfceba965fa","unresolved":false,"context_lines":[{"line_number":6,"context_line":""},{"line_number":7,"context_line":"Add the guideline to write API reference"},{"line_number":8,"context_line":""},{"line_number":9,"context_line":"Add the guideline to write API reference."},{"line_number":10,"context_line":""},{"line_number":11,"context_line":"Compute API reference:"},{"line_number":12,"context_line":"https://developer.openstack.org/api-ref/compute/"}],"source_content_type":"text/x-gerrit-commit-message","patch_set":7,"id":"3f79a3b5_e2c5a88f","line":9,"range":{"start_line":9,"start_character":0,"end_line":9,"end_character":41},"updated":"2018-08-08 15:46:42.000000000","message":"Duplicate of the commit title. Since this is mostly copied from the wiki:\n\nhttps://wiki.openstack.org/wiki/NovaAPIRef\n\nIt would be good to mention that in the commit message for reviewers.","commit_id":"f945952ecbe04d9e18e7202dc8ea2df9fcfce3c2"}],"doc/source/contributor/api-ref-guideline.rst":[{"author":{"_account_id":15888,"name":"Zhenyu Zheng","email":"zheng.zhenyu@outlook.com","username":"Kevin_Zheng"},"change_message_id":"aec4b89c6a281cfd67460574d39b78a9425ddb63","unresolved":false,"context_lines":[{"line_number":13,"context_line":"* `Placement API reference \u003chttps://developer.openstack.org/api-ref/placement/\u003e`_"},{"line_number":14,"context_line":""},{"line_number":15,"context_line":"The guideline to write the API reference"},{"line_number":16,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":17,"context_line":""},{"line_number":18,"context_line":"The API reference consists of the following files."},{"line_number":19,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_0387cdb8","line":16,"range":{"start_line":16,"start_character":38,"end_line":16,"end_character":40},"updated":"2018-05-17 11:04:34.000000000","message":"too long?","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"5c75825e82f8c31d9adc2c15b75922444d2436eb","unresolved":false,"context_lines":[{"line_number":13,"context_line":"* `Placement API reference \u003chttps://developer.openstack.org/api-ref/placement/\u003e`_"},{"line_number":14,"context_line":""},{"line_number":15,"context_line":"The guideline to write the API reference"},{"line_number":16,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":17,"context_line":""},{"line_number":18,"context_line":"The API reference consists of the following files."},{"line_number":19,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_69be1166","line":16,"range":{"start_line":16,"start_character":38,"end_line":16,"end_character":40},"in_reply_to":"5f7c97a3_0387cdb8","updated":"2018-05-28 23:52:25.000000000","message":"No.\nThey are same length.","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":15888,"name":"Zhenyu Zheng","email":"zheng.zhenyu@outlook.com","username":"Kevin_Zheng"},"change_message_id":"aec4b89c6a281cfd67460574d39b78a9425ddb63","unresolved":false,"context_lines":[{"line_number":71,"context_line":""},{"line_number":72,"context_line":"  The normal response code and error response codes have to be listed."},{"line_number":73,"context_line":"  The description of error response codes are as follows:"},{"line_number":74,"context_line":""},{"line_number":75,"context_line":"  .. list-table:: Error response codes"},{"line_number":76,"context_line":"     :header-rows: 1"},{"line_number":77,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_03758dcc","line":74,"updated":"2018-05-17 11:04:34.000000000","message":"Are there an order reference for error codes? I mean like 400,404,503","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"5c75825e82f8c31d9adc2c15b75922444d2436eb","unresolved":false,"context_lines":[{"line_number":71,"context_line":""},{"line_number":72,"context_line":"  The normal response code and error response codes have to be listed."},{"line_number":73,"context_line":"  The description of error response codes are as follows:"},{"line_number":74,"context_line":""},{"line_number":75,"context_line":"  .. list-table:: Error response codes"},{"line_number":76,"context_line":"     :header-rows: 1"},{"line_number":77,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_891fed6a","line":74,"in_reply_to":"5f7c97a3_03758dcc","updated":"2018-05-28 23:52:25.000000000","message":"Done","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":6062,"name":"jichenjc","email":"jichenjc@cn.ibm.com","username":"jichenjc"},"change_message_id":"eb236450118c4007eb92f1fc5b903e7c4a3f1b24","unresolved":false,"context_lines":[{"line_number":71,"context_line":""},{"line_number":72,"context_line":"  The normal response code and error response codes have to be listed."},{"line_number":73,"context_line":"  The description of error response codes are as follows:"},{"line_number":74,"context_line":""},{"line_number":75,"context_line":"  .. list-table:: Error response codes"},{"line_number":76,"context_line":"     :header-rows: 1"},{"line_number":77,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_08303307","line":74,"in_reply_to":"5f7c97a3_03758dcc","updated":"2018-05-18 07:47:27.000000000","message":"maybe add 200-204 as success code as well","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"5c75825e82f8c31d9adc2c15b75922444d2436eb","unresolved":false,"context_lines":[{"line_number":71,"context_line":""},{"line_number":72,"context_line":"  The normal response code and error response codes have to be listed."},{"line_number":73,"context_line":"  The description of error response codes are as follows:"},{"line_number":74,"context_line":""},{"line_number":75,"context_line":"  .. list-table:: Error response codes"},{"line_number":76,"context_line":"     :header-rows: 1"},{"line_number":77,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_29101959","line":74,"in_reply_to":"5f7c97a3_08303307","updated":"2018-05-28 23:52:25.000000000","message":"Done","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":15888,"name":"Zhenyu Zheng","email":"zheng.zhenyu@outlook.com","username":"Kevin_Zheng"},"change_message_id":"aec4b89c6a281cfd67460574d39b78a9425ddb63","unresolved":false,"context_lines":[{"line_number":102,"context_line":"  The request and response parameters have to be listed in the following order"},{"line_number":103,"context_line":"  in each API in the text file."},{"line_number":104,"context_line":""},{"line_number":105,"context_line":"  1. Header"},{"line_number":106,"context_line":"  2. Path"},{"line_number":107,"context_line":"  3. Query"},{"line_number":108,"context_line":"  4. Body"},{"line_number":109,"context_line":""},{"line_number":110,"context_line":"    1. Top level object (i.e. server)"},{"line_number":111,"context_line":"    2. Required fields"},{"line_number":112,"context_line":"    3. Optional fields"},{"line_number":113,"context_line":"    4. Parameters added in microversions (by the microversion they were added)"},{"line_number":114,"context_line":""},{"line_number":115,"context_line":"* Parameter type"},{"line_number":116,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_235be954","line":113,"range":{"start_line":105,"start_character":0,"end_line":113,"end_character":78},"updated":"2018-05-17 11:04:34.000000000","message":"this looks weird in the generated site","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"5c75825e82f8c31d9adc2c15b75922444d2436eb","unresolved":false,"context_lines":[{"line_number":102,"context_line":"  The request and response parameters have to be listed in the following order"},{"line_number":103,"context_line":"  in each API in the text file."},{"line_number":104,"context_line":""},{"line_number":105,"context_line":"  1. Header"},{"line_number":106,"context_line":"  2. Path"},{"line_number":107,"context_line":"  3. Query"},{"line_number":108,"context_line":"  4. Body"},{"line_number":109,"context_line":""},{"line_number":110,"context_line":"    1. Top level object (i.e. server)"},{"line_number":111,"context_line":"    2. Required fields"},{"line_number":112,"context_line":"    3. Optional fields"},{"line_number":113,"context_line":"    4. Parameters added in microversions (by the microversion they were added)"},{"line_number":114,"context_line":""},{"line_number":115,"context_line":"* Parameter type"},{"line_number":116,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_89c36ded","line":113,"range":{"start_line":105,"start_character":0,"end_line":113,"end_character":78},"in_reply_to":"5f7c97a3_235be954","updated":"2018-05-28 23:52:25.000000000","message":"Done","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":15888,"name":"Zhenyu Zheng","email":"zheng.zhenyu@outlook.com","username":"Kevin_Zheng"},"change_message_id":"aec4b89c6a281cfd67460574d39b78a9425ddb63","unresolved":false,"context_lines":[{"line_number":144,"context_line":"  .. list-table::"},{"line_number":145,"context_line":"    :widths: 15 85"},{"line_number":146,"context_line":""},{"line_number":147,"context_line":"    * - required (``true``)"},{"line_number":148,"context_line":"      - The parameter must be specified in the request, or"},{"line_number":149,"context_line":"        the parameter always appears in the response."},{"line_number":150,"context_line":"    * - optional (``false``)"},{"line_number":151,"context_line":"      - It is not always necessary to specify the parameter in the request, or"},{"line_number":152,"context_line":"        the parameter does not appear in the response in some cases."},{"line_number":153,"context_line":"        e.g. A config parameter defines whether the parameter appears"},{"line_number":154,"context_line":"        in the response or not. A parameter appears when administrators call"},{"line_number":155,"context_line":"        but does not appear when non-admin users call."},{"line_number":156,"context_line":""},{"line_number":157,"context_line":"  If a parameter must be specified in the request or always appears"},{"line_number":158,"context_line":"  in the response in the micoversion added or later,"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_03182c73","line":155,"range":{"start_line":147,"start_character":3,"end_line":155,"end_character":54},"updated":"2018-05-17 11:04:34.000000000","message":"It seems somehow missleading IMO, maybe we can mention TRUE and FALSE first and then ilustrate what they mean, since it looks to me that you are clearify what values for ``required`` field means what. Like:\n* - ``true``\n  - The parameter must be ...","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"5c75825e82f8c31d9adc2c15b75922444d2436eb","unresolved":false,"context_lines":[{"line_number":144,"context_line":"  .. list-table::"},{"line_number":145,"context_line":"    :widths: 15 85"},{"line_number":146,"context_line":""},{"line_number":147,"context_line":"    * - required (``true``)"},{"line_number":148,"context_line":"      - The parameter must be specified in the request, or"},{"line_number":149,"context_line":"        the parameter always appears in the response."},{"line_number":150,"context_line":"    * - optional (``false``)"},{"line_number":151,"context_line":"      - It is not always necessary to specify the parameter in the request, or"},{"line_number":152,"context_line":"        the parameter does not appear in the response in some cases."},{"line_number":153,"context_line":"        e.g. A config parameter defines whether the parameter appears"},{"line_number":154,"context_line":"        in the response or not. A parameter appears when administrators call"},{"line_number":155,"context_line":"        but does not appear when non-admin users call."},{"line_number":156,"context_line":""},{"line_number":157,"context_line":"  If a parameter must be specified in the request or always appears"},{"line_number":158,"context_line":"  in the response in the micoversion added or later,"}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_090bdd29","line":155,"range":{"start_line":147,"start_character":3,"end_line":155,"end_character":54},"in_reply_to":"5f7c97a3_03182c73","updated":"2018-05-28 23:52:25.000000000","message":"Done","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":6062,"name":"jichenjc","email":"jichenjc@cn.ibm.com","username":"jichenjc"},"change_message_id":"eb236450118c4007eb92f1fc5b903e7c4a3f1b24","unresolved":false,"context_lines":[{"line_number":156,"context_line":""},{"line_number":157,"context_line":"  If a parameter must be specified in the request or always appears"},{"line_number":158,"context_line":"  in the response in the micoversion added or later,"},{"line_number":159,"context_line":"  The parameter should be defined as required (it is not optional)."},{"line_number":160,"context_line":""},{"line_number":161,"context_line":"* The order of parameters in the parameter file"},{"line_number":162,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_a8201fb2","line":159,"range":{"start_line":159,"start_character":16,"end_line":159,"end_character":22},"updated":"2018-05-18 07:47:27.000000000","message":"must","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"5c75825e82f8c31d9adc2c15b75922444d2436eb","unresolved":false,"context_lines":[{"line_number":156,"context_line":""},{"line_number":157,"context_line":"  If a parameter must be specified in the request or always appears"},{"line_number":158,"context_line":"  in the response in the micoversion added or later,"},{"line_number":159,"context_line":"  The parameter should be defined as required (it is not optional)."},{"line_number":160,"context_line":""},{"line_number":161,"context_line":"* The order of parameters in the parameter file"},{"line_number":162,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_c9a4054e","line":159,"range":{"start_line":159,"start_character":16,"end_line":159,"end_character":22},"in_reply_to":"5f7c97a3_a8201fb2","updated":"2018-05-28 23:52:25.000000000","message":"Done","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":15888,"name":"Zhenyu Zheng","email":"zheng.zhenyu@outlook.com","username":"Kevin_Zheng"},"change_message_id":"aec4b89c6a281cfd67460574d39b78a9425ddb63","unresolved":false,"context_lines":[{"line_number":162,"context_line":""},{"line_number":163,"context_line":"  The order of parameters in the parameter file has to be kept as follows:"},{"line_number":164,"context_line":""},{"line_number":165,"context_line":"  1. By in type"},{"line_number":166,"context_line":""},{"line_number":167,"context_line":"    1. Header"},{"line_number":168,"context_line":"    2. Path"},{"line_number":169,"context_line":"    3. Query"},{"line_number":170,"context_line":"    4. Body"},{"line_number":171,"context_line":""},{"line_number":172,"context_line":"  2. Then alphabetical by name"},{"line_number":173,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_03310ced","line":170,"range":{"start_line":165,"start_character":0,"end_line":170,"end_character":11},"updated":"2018-05-17 11:04:34.000000000","message":"This also looks weird in the output site.","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"5c75825e82f8c31d9adc2c15b75922444d2436eb","unresolved":false,"context_lines":[{"line_number":162,"context_line":""},{"line_number":163,"context_line":"  The order of parameters in the parameter file has to be kept as follows:"},{"line_number":164,"context_line":""},{"line_number":165,"context_line":"  1. By in type"},{"line_number":166,"context_line":""},{"line_number":167,"context_line":"    1. Header"},{"line_number":168,"context_line":"    2. Path"},{"line_number":169,"context_line":"    3. Query"},{"line_number":170,"context_line":"    4. Body"},{"line_number":171,"context_line":""},{"line_number":172,"context_line":"  2. Then alphabetical by name"},{"line_number":173,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"5f7c97a3_29b49981","line":170,"range":{"start_line":165,"start_character":0,"end_line":170,"end_character":11},"in_reply_to":"5f7c97a3_03310ced","updated":"2018-05-28 23:52:25.000000000","message":"Done","commit_id":"ed8609faa7c4a59fea43b3c3a4978f01b63da1a6"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":65,"context_line":"  The spelling and the case of method names in the title have to match"},{"line_number":66,"context_line":"  what is in the code. For instance, the title for the section on method"},{"line_number":67,"context_line":"  \"Get Rdp Console\" should be \"Get Rdp Console (os-getRDPConsole Action)\""},{"line_number":68,"context_line":"  NOT \"Get Rdp Console (Os-Getrdpconsole Action)\""},{"line_number":69,"context_line":""},{"line_number":70,"context_line":"* Response codes"},{"line_number":71,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"5f7c97a3_af140045","line":68,"updated":"2018-07-14 00:53:31.000000000","message":"+1, readable for users.","commit_id":"76975e9809d7a839bb6cb9fff981c00f4e308559"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":2,"context_line":"API reference guideline"},{"line_number":3,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"},{"line_number":4,"context_line":""},{"line_number":5,"context_line":"The API reference should be updated when compute or placement APIs are modiied"},{"line_number":6,"context_line":"(microversion is bumped, etc.)."},{"line_number":7,"context_line":"This page describes the guideline for the API reference."},{"line_number":8,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_145b3f55","line":5,"range":{"start_line":5,"start_character":71,"end_line":5,"end_character":78},"updated":"2018-07-14 00:53:31.000000000","message":"s/modiied/modified/ or \"changed\"","commit_id":"417af56767e6e3c24fae445db791a33dee0be8fd"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":4,"context_line":""},{"line_number":5,"context_line":"The API reference should be updated when compute or placement APIs are modiied"},{"line_number":6,"context_line":"(microversion is bumped, etc.)."},{"line_number":7,"context_line":"This page describes the guideline for the API reference."},{"line_number":8,"context_line":""},{"line_number":9,"context_line":"API reference"},{"line_number":10,"context_line":"\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d\u003d"}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_d454e724","line":7,"range":{"start_line":7,"start_character":34,"end_line":7,"end_character":38},"updated":"2018-07-14 00:53:31.000000000","message":"s/for/for updating/","commit_id":"417af56767e6e3c24fae445db791a33dee0be8fd"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"* The order of methods"},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"  Methods have to be sorted in the following way:"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"  1. GET"},{"line_number":49,"context_line":"  2. POST"}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_1409ff30","line":46,"range":{"start_line":46,"start_character":21,"end_line":46,"end_character":30},"updated":"2018-07-14 00:53:31.000000000","message":"How about\n\n sorted by each URI in the following order:\n\nfor matching the following /servers sample.\n(I was a little confused due to the sort of 2 and 3-4 on the sample)","commit_id":"417af56767e6e3c24fae445db791a33dee0be8fd"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":69,"context_line":""},{"line_number":70,"context_line":"* Response codes"},{"line_number":71,"context_line":""},{"line_number":72,"context_line":"  The normal response codes (200, 201, 202, 204) and error response codes"},{"line_number":73,"context_line":"  have to be listed. The order of response codes should be in ascending order."},{"line_number":74,"context_line":"  The description of error response codes are as follows:"},{"line_number":75,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_f4fd6309","line":72,"range":{"start_line":72,"start_character":29,"end_line":72,"end_character":47},"updated":"2018-07-14 00:53:31.000000000","message":"How about (20x) for long-term maintenance?","commit_id":"417af56767e6e3c24fae445db791a33dee0be8fd"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":115,"context_line":""},{"line_number":116,"context_line":"* Parameter type"},{"line_number":117,"context_line":""},{"line_number":118,"context_line":"  The parameters is defined in the parameter file (``parameters.yaml``)."},{"line_number":119,"context_line":"  The type of parameters have to be one of followings:"},{"line_number":120,"context_line":""},{"line_number":121,"context_line":"  * ``array``"}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_57045914","line":118,"range":{"start_line":118,"start_character":17,"end_line":118,"end_character":19},"updated":"2018-07-14 00:53:31.000000000","message":"s/is/are/","commit_id":"417af56767e6e3c24fae445db791a33dee0be8fd"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":127,"context_line":"  * ``integer``"},{"line_number":128,"context_line":"  * ``none``"},{"line_number":129,"context_line":""},{"line_number":130,"context_line":"    The value is always ``null`` or should be ``null``."},{"line_number":131,"context_line":""},{"line_number":132,"context_line":"  * ``object``"},{"line_number":133,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_571d3960","line":130,"range":{"start_line":130,"start_character":4,"end_line":130,"end_character":55},"updated":"2018-07-14 00:53:31.000000000","message":"TBO I am not sure that is a difference between \"is always\" and \"should be\"..\n\nIs that\n\n The value is always ``null`` in a response or should be ``null`` in a request.\n\n?","commit_id":"417af56767e6e3c24fae445db791a33dee0be8fd"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"73d024f4fd8c2c5182b06edc2a00a7f46e9d45f9","unresolved":false,"context_lines":[{"line_number":157,"context_line":""},{"line_number":158,"context_line":"  If a parameter must be specified in the request or always appears"},{"line_number":159,"context_line":"  in the response in the micoversion added or later,"},{"line_number":160,"context_line":"  The parameter must be defined as required (``true``)."},{"line_number":161,"context_line":""},{"line_number":162,"context_line":"* The order of parameters in the parameter file"},{"line_number":163,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"5f7c97a3_9748b162","line":160,"range":{"start_line":160,"start_character":2,"end_line":160,"end_character":5},"updated":"2018-07-14 00:53:31.000000000","message":"s/The/the/","commit_id":"417af56767e6e3c24fae445db791a33dee0be8fd"},{"author":{"_account_id":8556,"name":"Ghanshyam Maan","display_name":"Ghanshyam Maan","email":"gmaan.os14@gmail.com","username":"ghanshyam"},"change_message_id":"6b79b72fa6c09d2ce16290b83de76de0d4b412ec","unresolved":false,"context_lines":[{"line_number":34,"context_line":"    ``placement-api-ref/source/parameters.yaml``"},{"line_number":35,"context_line":"  * JSON request/response samples"},{"line_number":36,"context_line":"    ``placement-api-ref/source/samples/*``"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Method"},{"line_number":39,"context_line":"------"},{"line_number":40,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_472c3a00","line":37,"range":{"start_line":37,"start_character":0,"end_line":37,"end_character":0},"updated":"2018-07-19 07:12:46.000000000","message":"here you should tell about complete structure of api-ref. like\n\n- name of .inc file\n- title\n- sub heading\n   - REST Method\n       - url\n       - description\n       - normal status code\n       - error status code\n       - Request\n         - parameters\n         - sample file example\n       - Response\n         - parameters\n         - sample file example\n\nAnd then further you explain each section and content of each heading in detail.","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"4d040c27dacf7fb993eb04701eb55a82530c2d5c","unresolved":false,"context_lines":[{"line_number":34,"context_line":"    ``placement-api-ref/source/parameters.yaml``"},{"line_number":35,"context_line":"  * JSON request/response samples"},{"line_number":36,"context_line":"    ``placement-api-ref/source/samples/*``"},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Method"},{"line_number":39,"context_line":"------"},{"line_number":40,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_11a1243b","line":37,"range":{"start_line":37,"start_character":0,"end_line":37,"end_character":0},"in_reply_to":"5f7c97a3_472c3a00","updated":"2018-07-25 03:09:33.000000000","message":"Done","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":8556,"name":"Ghanshyam Maan","display_name":"Ghanshyam Maan","email":"gmaan.os14@gmail.com","username":"ghanshyam"},"change_message_id":"6b79b72fa6c09d2ce16290b83de76de0d4b412ec","unresolved":false,"context_lines":[{"line_number":38,"context_line":"Method"},{"line_number":39,"context_line":"------"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Each REST API is described in the text file."},{"line_number":42,"context_line":"The guideline for describing HTTP methods is described in this section."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"* The order of methods"}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_e73a2695","line":41,"range":{"start_line":41,"start_character":0,"end_line":41,"end_character":44},"updated":"2018-07-19 07:12:46.000000000","message":"this should be before Method section.","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"4d040c27dacf7fb993eb04701eb55a82530c2d5c","unresolved":false,"context_lines":[{"line_number":38,"context_line":"Method"},{"line_number":39,"context_line":"------"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Each REST API is described in the text file."},{"line_number":42,"context_line":"The guideline for describing HTTP methods is described in this section."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"* The order of methods"}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_31ac6035","line":41,"range":{"start_line":41,"start_character":0,"end_line":41,"end_character":44},"in_reply_to":"5f7c97a3_e73a2695","updated":"2018-07-25 03:09:33.000000000","message":"Done","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":8556,"name":"Ghanshyam Maan","display_name":"Ghanshyam Maan","email":"gmaan.os14@gmail.com","username":"ghanshyam"},"change_message_id":"6b79b72fa6c09d2ce16290b83de76de0d4b412ec","unresolved":false,"context_lines":[{"line_number":39,"context_line":"------"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Each REST API is described in the text file."},{"line_number":42,"context_line":"The guideline for describing HTTP methods is described in this section."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"* The order of methods"},{"line_number":45,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_87b4921e","line":42,"range":{"start_line":42,"start_character":70,"end_line":42,"end_character":71},"updated":"2018-07-19 07:12:46.000000000","message":"You should add - All supported methods by resource should be listed in api-ref","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"4d040c27dacf7fb993eb04701eb55a82530c2d5c","unresolved":false,"context_lines":[{"line_number":39,"context_line":"------"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"Each REST API is described in the text file."},{"line_number":42,"context_line":"The guideline for describing HTTP methods is described in this section."},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"* The order of methods"},{"line_number":45,"context_line":""}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_f1a58849","line":42,"range":{"start_line":42,"start_character":70,"end_line":42,"end_character":71},"in_reply_to":"5f7c97a3_87b4921e","updated":"2018-07-25 03:09:33.000000000","message":"Done","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":8556,"name":"Ghanshyam Maan","display_name":"Ghanshyam Maan","email":"gmaan.os14@gmail.com","username":"ghanshyam"},"change_message_id":"6b79b72fa6c09d2ce16290b83de76de0d4b412ec","unresolved":false,"context_lines":[{"line_number":71,"context_line":""},{"line_number":72,"context_line":"  The normal response codes (20x) and error response codes"},{"line_number":73,"context_line":"  have to be listed. The order of response codes should be in ascending order."},{"line_number":74,"context_line":"  The description of error response codes are as follows:"},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"  .. list-table:: Error response codes"},{"line_number":77,"context_line":"     :header-rows: 1"}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_c7c84a76","line":74,"range":{"start_line":74,"start_character":1,"end_line":74,"end_character":57},"updated":"2018-07-19 07:12:46.000000000","message":"these are not all response code. you should give ref to RFC doc - https://tools.ietf.org/html/rfc7231#section-6","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"4d040c27dacf7fb993eb04701eb55a82530c2d5c","unresolved":false,"context_lines":[{"line_number":71,"context_line":""},{"line_number":72,"context_line":"  The normal response codes (20x) and error response codes"},{"line_number":73,"context_line":"  have to be listed. The order of response codes should be in ascending order."},{"line_number":74,"context_line":"  The description of error response codes are as follows:"},{"line_number":75,"context_line":""},{"line_number":76,"context_line":"  .. list-table:: Error response codes"},{"line_number":77,"context_line":"     :header-rows: 1"}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_f1534839","line":74,"range":{"start_line":74,"start_character":1,"end_line":74,"end_character":57},"in_reply_to":"5f7c97a3_c7c84a76","updated":"2018-07-25 03:09:33.000000000","message":"\u003e these are not all response code.\n\nCorrect.\nBut IMO, it is enough to list typical error response codes here.\nSo add \u0027typical\u0027 in the description.","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":8556,"name":"Ghanshyam Maan","display_name":"Ghanshyam Maan","email":"gmaan.os14@gmail.com","username":"ghanshyam"},"change_message_id":"6b79b72fa6c09d2ce16290b83de76de0d4b412ec","unresolved":false,"context_lines":[{"line_number":103,"context_line":"  The request and response parameters have to be listed in the following order"},{"line_number":104,"context_line":"  in each API in the text file."},{"line_number":105,"context_line":""},{"line_number":106,"context_line":"  1. Header"},{"line_number":107,"context_line":"  2. Path"},{"line_number":108,"context_line":"  3. Query"},{"line_number":109,"context_line":"  4. Body"},{"line_number":110,"context_line":""},{"line_number":111,"context_line":"     a. Top level object (i.e. server)"},{"line_number":112,"context_line":"     b. Required fields"}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_27b6dedd","line":109,"range":{"start_line":106,"start_character":0,"end_line":109,"end_character":9},"updated":"2018-07-19 07:12:46.000000000","message":"these needs to be defined by 2 sections 1. \u0027Request\u0027 2. \u0027Response\u0027. Path, Query, Request headers and attribute  goes in \u0027Request\u0027 section and Response headers and attributes  goes in \u0027Response\u0027 section.","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"4d040c27dacf7fb993eb04701eb55a82530c2d5c","unresolved":false,"context_lines":[{"line_number":103,"context_line":"  The request and response parameters have to be listed in the following order"},{"line_number":104,"context_line":"  in each API in the text file."},{"line_number":105,"context_line":""},{"line_number":106,"context_line":"  1. Header"},{"line_number":107,"context_line":"  2. Path"},{"line_number":108,"context_line":"  3. Query"},{"line_number":109,"context_line":"  4. Body"},{"line_number":110,"context_line":""},{"line_number":111,"context_line":"     a. Top level object (i.e. server)"},{"line_number":112,"context_line":"     b. Required fields"}],"source_content_type":"text/x-rst","patch_set":5,"id":"5f7c97a3_d12e4ca9","line":109,"range":{"start_line":106,"start_character":0,"end_line":109,"end_character":9},"in_reply_to":"5f7c97a3_27b6dedd","updated":"2018-07-25 03:09:33.000000000","message":"Done","commit_id":"ae783b15f5d3f9a5b8fb53cf528731bf49a2039b"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"c4435163b3b3c8dc526c0bcb5878e3a4229364c7","unresolved":false,"context_lines":[{"line_number":126,"context_line":"Parameter"},{"line_number":127,"context_line":"---------"},{"line_number":128,"context_line":""},{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_76b49781","line":129,"range":{"start_line":129,"start_character":11,"end_line":129,"end_character":16},"updated":"2018-07-31 02:21:41.000000000","message":"s/needs/need/","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"f055c9ddbf7806c253066ce22809416efd4a2c50","unresolved":false,"context_lines":[{"line_number":126,"context_line":"Parameter"},{"line_number":127,"context_line":"---------"},{"line_number":128,"context_line":""},{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_54de330f","line":129,"range":{"start_line":129,"start_character":11,"end_line":129,"end_character":16},"in_reply_to":"5f7c97a3_76b49781","updated":"2018-07-31 05:24:41.000000000","message":"Done","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"c4435163b3b3c8dc526c0bcb5878e3a4229364c7","unresolved":false,"context_lines":[{"line_number":128,"context_line":""},{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"},{"line_number":133,"context_line":"subsection."},{"line_number":134,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_d6a24b40","line":131,"range":{"start_line":131,"start_character":54,"end_line":131,"end_character":58},"updated":"2018-07-31 02:21:41.000000000","message":"s/goes/go/","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"c4435163b3b3c8dc526c0bcb5878e3a4229364c7","unresolved":false,"context_lines":[{"line_number":128,"context_line":""},{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"},{"line_number":133,"context_line":"subsection."},{"line_number":134,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_36aa9f19","line":131,"range":{"start_line":131,"start_character":16,"end_line":131,"end_character":21},"updated":"2018-07-31 02:21:41.000000000","message":"s/query/queries/","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"f055c9ddbf7806c253066ce22809416efd4a2c50","unresolved":false,"context_lines":[{"line_number":128,"context_line":""},{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"},{"line_number":133,"context_line":"subsection."},{"line_number":134,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_74e32fd8","line":131,"range":{"start_line":131,"start_character":16,"end_line":131,"end_character":21},"in_reply_to":"5f7c97a3_36aa9f19","updated":"2018-07-31 05:24:41.000000000","message":"Done","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"f055c9ddbf7806c253066ce22809416efd4a2c50","unresolved":false,"context_lines":[{"line_number":128,"context_line":""},{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"},{"line_number":133,"context_line":"subsection."},{"line_number":134,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_14cc3b60","line":131,"range":{"start_line":131,"start_character":54,"end_line":131,"end_character":58},"in_reply_to":"5f7c97a3_d6a24b40","updated":"2018-07-31 05:24:41.000000000","message":"Done","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":6167,"name":"Ken\u0027ichi Ohmichi","email":"ken1ohmichi@gmail.com","username":"oomichi"},"change_message_id":"c4435163b3b3c8dc526c0bcb5878e3a4229364c7","unresolved":false,"context_lines":[{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"},{"line_number":133,"context_line":"subsection."},{"line_number":134,"context_line":""},{"line_number":135,"context_line":"* The order of parameters in each API"}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_f69f47f3","line":132,"range":{"start_line":132,"start_character":47,"end_line":132,"end_character":51},"updated":"2018-07-31 02:21:41.000000000","message":"s/goes/go/","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":7634,"name":"Takashi Natsume","email":"takanattie@gmail.com","username":"natsumet"},"change_message_id":"f055c9ddbf7806c253066ce22809416efd4a2c50","unresolved":false,"context_lines":[{"line_number":129,"context_line":"Parameters needs to be defined by 2 subsections."},{"line_number":130,"context_line":"The one is in the \u0027Request\u0027 subsection, the other is in the \u0027Response\u0027"},{"line_number":131,"context_line":"subsection. The query, request headers and attributes goes in the \u0027Request\u0027"},{"line_number":132,"context_line":"subsection and response headers and attributes goes in the \u0027Response\u0027"},{"line_number":133,"context_line":"subsection."},{"line_number":134,"context_line":""},{"line_number":135,"context_line":"* The order of parameters in each API"}],"source_content_type":"text/x-rst","patch_set":6,"id":"5f7c97a3_34c93750","line":132,"range":{"start_line":132,"start_character":47,"end_line":132,"end_character":51},"in_reply_to":"5f7c97a3_f69f47f3","updated":"2018-07-31 05:24:41.000000000","message":"Done","commit_id":"a3f8e63bb57c7c90c45f6d75e32e7fabf5a34c8d"},{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"eaec31a5f7d0d9571a309e6810c01cfceba965fa","unresolved":false,"context_lines":[{"line_number":17,"context_line":""},{"line_number":18,"context_line":"The API reference consists of the following files."},{"line_number":19,"context_line":""},{"line_number":20,"context_line":"* Compute API reference"},{"line_number":21,"context_line":""},{"line_number":22,"context_line":"  * API reference text"},{"line_number":23,"context_line":"    ``api-ref/source/*.inc``"},{"line_number":24,"context_line":"  * Parameter definition"},{"line_number":25,"context_line":"    ``api-ref/source/parameters.yaml``"},{"line_number":26,"context_line":"  * JSON request/response samples"},{"line_number":27,"context_line":"    ``doc/api_samples/*``"},{"line_number":28,"context_line":""},{"line_number":29,"context_line":"* Placement API reference"},{"line_number":30,"context_line":""}],"source_content_type":"text/x-rst","patch_set":7,"id":"3f79a3b5_227080a5","line":27,"range":{"start_line":20,"start_character":0,"end_line":27,"end_character":25},"updated":"2018-08-08 15:46:42.000000000","message":"nit: this could all be less tree-like if you used sub-sections, like:\n\nCompute API reference\n---------------------\n\n* API reference text\n* Parameter definition\n...","commit_id":"f945952ecbe04d9e18e7202dc8ea2df9fcfce3c2"},{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"eaec31a5f7d0d9571a309e6810c01cfceba965fa","unresolved":false,"context_lines":[{"line_number":69,"context_line":"The guideline for describing HTTP methods is described in this section."},{"line_number":70,"context_line":"All supported methods by resource should be listed in the API reference."},{"line_number":71,"context_line":""},{"line_number":72,"context_line":"* The order of methods"},{"line_number":73,"context_line":""},{"line_number":74,"context_line":"  Methods have to be sorted by each URI in the following order:"},{"line_number":75,"context_line":""}],"source_content_type":"text/x-rst","patch_set":7,"id":"3f79a3b5_026544e1","line":72,"range":{"start_line":72,"start_character":0,"end_line":72,"end_character":22},"updated":"2018-08-08 15:46:42.000000000","message":"Could we make this a sub-section using:\n\nThe order of methods\n~~~~~~~~~~~~~~~~~~~~\n\n?","commit_id":"f945952ecbe04d9e18e7202dc8ea2df9fcfce3c2"},{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"eaec31a5f7d0d9571a309e6810c01cfceba965fa","unresolved":false,"context_lines":[{"line_number":123,"context_line":"     * - 503"},{"line_number":124,"context_line":"       - serviceUnavailable(503)"},{"line_number":125,"context_line":""},{"line_number":126,"context_line":"Parameter"},{"line_number":127,"context_line":"---------"},{"line_number":128,"context_line":""},{"line_number":129,"context_line":"Parameters need to be defined by 2 subsections."}],"source_content_type":"text/x-rst","patch_set":7,"id":"3f79a3b5_42a81cda","line":126,"range":{"start_line":126,"start_character":0,"end_line":126,"end_character":9},"updated":"2018-08-08 15:46:42.000000000","message":"nit: Parameters","commit_id":"f945952ecbe04d9e18e7202dc8ea2df9fcfce3c2"},{"author":{"_account_id":6873,"name":"Matt Riedemann","email":"mriedem.os@gmail.com","username":"mriedem"},"change_message_id":"eaec31a5f7d0d9571a309e6810c01cfceba965fa","unresolved":false,"context_lines":[{"line_number":186,"context_line":"    * - ``false``"},{"line_number":187,"context_line":"      - It is not always necessary to specify the parameter in the request, or"},{"line_number":188,"context_line":"        the parameter does not appear in the response in some cases."},{"line_number":189,"context_line":"        e.g. A config parameter defines whether the parameter appears"},{"line_number":190,"context_line":"        in the response or not. A parameter appears when administrators call"},{"line_number":191,"context_line":"        but does not appear when non-admin users call."},{"line_number":192,"context_line":""}],"source_content_type":"text/x-rst","patch_set":7,"id":"3f79a3b5_42f6dcfb","line":189,"range":{"start_line":189,"start_character":22,"end_line":189,"end_character":31},"updated":"2018-08-08 15:46:42.000000000","message":"option? I had to read this a few times to realize you\u0027re talking about config-driven API behavior. Saying config parameter when talking about API parameters is confusing.","commit_id":"f945952ecbe04d9e18e7202dc8ea2df9fcfce3c2"}]}