)]}'
{"id":"openstack%2Fcinder-specs~660621","triplet_id":"openstack%2Fcinder-specs~master~Iae0d9cf38bda6f56b5a76a90a5cb38e11da4efdc","project":"openstack/cinder-specs","branch":"master","topic":"bp/improve-cinder-apis-docs","hashtags":[],"change_id":"Iae0d9cf38bda6f56b5a76a90a5cb38e11da4efdc","subject":"Improve the cinder API docs","status":"ABANDONED","created":"2019-05-22 09:58:52.000000000","updated":"2019-12-09 20:20:04.000000000","total_comment_count":6,"unresolved_comment_count":0,"has_review_started":true,"meta_rev_id":"eae4296a8ebf25312ccae605ce018245c73baa46","_number":660621,"virtual_id_number":660621,"owner":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"actions":{},"labels":{"Verified":{"recommended":{"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]},"all":[{"date":"2019-05-23 13:47:46.000000000","_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},{"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},{"value":1,"date":"2019-05-22 12:20:15.000000000","permitted_voting_range":{"min":-2,"max":2},"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]}],"values":{"-2":"Fails","-1":"Doesn\u0027t seem to work"," 0":"No score","+1":"Works for me","+2":"Verified"},"description":"","value":1,"default_value":0,"optional":true},"Code-Review":{"all":[{"value":0,"permitted_voting_range":{"min":-2,"max":2},"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},{"value":0,"permitted_voting_range":{"min":-2,"max":2},"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},{"value":0,"permitted_voting_range":{"min":-1,"max":1},"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},{"value":0,"permitted_voting_range":{"min":-1,"max":1},"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]}],"values":{"-2":"Do not merge","-1":"This patch needs further work before it can be merged"," 0":"No score","+1":"Looks good to me, but someone else must approve","+2":"Looks good to me (core reviewer)"},"description":"","default_value":0,"optional":true},"Workflow":{"rejected":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"all":[{"value":0,"permitted_voting_range":{"min":-1,"max":1},"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},{"value":0,"date":"2019-05-22 12:44:18.000000000","permitted_voting_range":{"min":-1,"max":1},"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},{"value":-1,"date":"2019-05-28 10:35:07.000000000","permitted_voting_range":{"min":-1,"max":0},"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},{"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]}],"values":{"-1":"Work in progress"," 0":"Ready for reviews","+1":"Approved"},"description":"","default_value":0,"optional":true}},"removable_reviewers":[],"reviewers":{"REVIEWER":[{"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},{"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]},{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"}]},"pending_reviewers":{},"reviewer_updates":[{"updated":"2019-05-22 12:20:15.000000000","updated_by":{"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]},"reviewer":{"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]},"state":"REVIEWER"},{"updated":"2019-05-22 12:44:18.000000000","updated_by":{"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},"reviewer":{"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},"state":"REVIEWER"},{"updated":"2019-05-23 13:47:46.000000000","updated_by":{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},"reviewer":{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},"state":"REVIEWER"}],"messages":[{"id":"1c23b635df7c6194033f93f7cc5e208290e3303b","author":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"date":"2019-05-22 09:58:52.000000000","message":"Uploaded patch set 1.","accounts_in_message":[],"_revision_number":1},{"id":"de5f95a60d982fe8ad133596b3e9585f27864c3f","author":{"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]},"date":"2019-05-22 10:06:58.000000000","message":"Patch Set 1: Verified+1\n\nBuild succeeded (check pipeline).\n\n- openstack-tox-docs http://logs.openstack.org/21/660621/1/check/openstack-tox-docs/bf64e43/html/ : SUCCESS in 4m 02s\n- openstack-tox-pep8 http://logs.openstack.org/21/660621/1/check/openstack-tox-pep8/f4c3bc0/ : SUCCESS in 3m 24s","accounts_in_message":[],"_revision_number":1},{"id":"f15c7550cba39db0433e7369108001a17e6500e9","author":{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},"date":"2019-05-22 11:32:52.000000000","message":"Patch Set 1: Code-Review-1\n\n(3 comments)\n\nI have no idea what you are actually talking about here.","accounts_in_message":[],"_revision_number":1},{"id":"eb704c11a5ced134f10e430c719d762a4a5d0501","author":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"date":"2019-05-22 11:44:24.000000000","message":"Patch Set 1:\n\n(3 comments)\n\nThanks Sean.","accounts_in_message":[],"_revision_number":1},{"id":"f35148a813c61d57feddc821ee7ad6183fb4ca06","author":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"date":"2019-05-22 12:10:28.000000000","message":"Uploaded patch set 2.","accounts_in_message":[],"_revision_number":2},{"id":"ac48a37a9fc7515bbd62d85f1f36bd45632d789b","author":{"_account_id":22348,"name":"Zuul","username":"zuul","tags":["SERVICE_USER"]},"date":"2019-05-22 12:20:15.000000000","message":"Patch Set 2: Verified+1\n\nBuild succeeded (check pipeline).\n\n- openstack-tox-docs http://logs.openstack.org/21/660621/2/check/openstack-tox-docs/e356cc8/html/ : SUCCESS in 4m 14s\n- openstack-tox-pep8 http://logs.openstack.org/21/660621/2/check/openstack-tox-pep8/312367d/ : SUCCESS in 2m 47s","accounts_in_message":[],"_revision_number":2},{"id":"718a0c1026af2caa3290f852edb94b88979a00f5","author":{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},"date":"2019-05-22 13:13:26.000000000","message":"Patch Set 2:\n\nI\u0027m still not clear, but if you are referring to filtering options, that\u0027s entirely controlled by the admin configuration and they are not parameters of the API call. See https://specs.openstack.org/openstack/cinder-specs/specs/pike/generalized_list_filters.html for more details about how that mechanism works.\n\nSpecs are for discussing design decisions. This sounds more like a long bug report if you are saying something is missing from the api docs (https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded\u003dlist-accessible-volumes-with-details-detail#list-accessible-volumes-with-details). Maybe I\u0027m missing something, so please explain what needs to be rearchitected in order to do what you are proposing.","accounts_in_message":[],"_revision_number":2},{"id":"91cd4705b889e1d70b8492657d542e59baad09a4","author":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"date":"2019-05-23 03:36:21.000000000","message":"Patch Set 2:\n\nThanks Sean.\n\n \u003e I\u0027m still not clear, but if you are referring to filtering options,\n \u003e that\u0027s entirely controlled by the admin configuration and they are\n \u003e not parameters of the API call. See https://specs.openstack.org/openstack/cinder-specs/specs/pike/generalized_list_filters.html\n\nI did not notice this management mechanism for the resource, so I entered a misunderstanding.\nMy intention is to add the parameters supported in \"cinder list-filters --resource \u003cresource\u003e\" to the list API, to make the API documentation clearer and easier to read, but it\u0027s opposite of this implementation.\nPersonally, I prefer the implementation of the nova list API, listing the parameters of each interface implementation in the current request body (But, it is difficult to cater for all tastes :D).\n\n \u003e Maybe I\u0027m missing something, so please explain what needs to be\n \u003e rearchitected in order to do what you are proposing.\n\nWhat about now， is clear ?","accounts_in_message":[],"_revision_number":2},{"id":"d590a52741a9743e7101bbf66f2a594ca399fe9f","author":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"date":"2019-05-23 03:43:12.000000000","message":"Patch Set 2:\n\n\u003e Specs are for discussing design decisions. This sounds more like a\n \u003e long bug report if you are saying something is missing from the api\n \u003e docs (https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded\u003dlist-accessible-volumes-with-details-detail#list-accessible-volumes-with-details).\n\nA question:\nIn List all volume types API [1], there is exist the optional parameter \u0027is_public\u0027 , and ``cinder list-filters --resource volume_type`` can show the attribute too. Do I need to remove the \u0027is_public\u0027 field from the List all volume types API docs?\n\n[1]https://developer.openstack.org/api-ref/block-storage/v3/index.html?expanded\u003dlist-accessible-volumes-with-details-detail#list-all-volume-types","accounts_in_message":[],"_revision_number":2},{"id":"c0d7dd26b75a24b54da9e0dd3a45d6a4b32bca53","author":{"_account_id":11904,"name":"Sean McGinnis","email":"sean.mcginnis@gmail.com","username":"SeanM"},"date":"2019-05-23 13:47:46.000000000","message":"Patch Set 2:\n\n\u003e What about now， is clear ?\n\nNo, sorry, not at all. I still don\u0027t understand why there isn\u0027t just a patch against the api-ref docs to add whatever it is you see missing. What is the architectural design change you are proposing that needs a blueprint and spec to work through?","accounts_in_message":[],"_revision_number":2},{"id":"91fda96ea91357049fd1f72847d627ef4afab18f","author":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"date":"2019-05-28 10:35:07.000000000","message":"Patch Set 2: Workflow-1","accounts_in_message":[],"_revision_number":2},{"id":"672b7e476724ade58d53f30b5170e3df91dd4ba3","author":{"_account_id":5314,"name":"Brian Rosmaita","email":"rosmaita.fossdev@gmail.com","username":"brian-rosmaita"},"date":"2019-12-09 20:20:04.000000000","message":"Abandoned\n\nNo action in over 6 months.  Feel free to reopen if this still relevant.","accounts_in_message":[],"_revision_number":2}],"current_revision_number":2,"current_revision":"8e66e58950a2c358d40c991179b482830a8001bc","revisions":{"962d2c1a84c2d935d87ef157dc808ceeac23b794":{"kind":"REWORK","_number":1,"created":"2019-05-22 09:58:52.000000000","uploader":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"ref":"refs/changes/21/660621/1","fetch":{"anonymous http":{"url":"https://review.opendev.org/openstack/cinder-specs","ref":"refs/changes/21/660621/1","commands":{"Checkout":"git fetch https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/1 \u0026\u0026 git checkout FETCH_HEAD","Cherry Pick":"git fetch https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/1 \u0026\u0026 git cherry-pick FETCH_HEAD","Format Patch":"git fetch https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/1 \u0026\u0026 git format-patch -1 --stdout FETCH_HEAD","Pull":"git pull https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/1"}}},"commit":{"parents":[{"commit":"8034f0d87808e3ee3f69fe955b42cec512db813f","subject":"OpenDev Migration Patch","web_links":[{"name":"gitea","tooltip":"Open in GitWeb","url":"https://opendev.org/openstack/cinder-specs/commit/8034f0d87808e3ee3f69fe955b42cec512db813f"}]}],"author":{"name":"zhangbailin","email":"zhangbailin@inspur.com","date":"2019-05-22 09:52:52.000000000","tz":480},"committer":{"name":"zhangbailin","email":"zhangbailin@inspur.com","date":"2019-05-22 09:53:44.000000000","tz":480},"subject":"Improve the cinder API docs","message":"Improve the cinder API docs\n\nThe current cinder list APIs can\u0027t display the request parameters of the\ninterface, which is unfriendly to the user or the developer. Why can\u0027t\nit be displayed clearly like the nova API, and it is easy to maintain.\nOf course, you can also do this in two steps. First, use the List\nresource filters API to get the filter fields of resources, and then use\nthe corresponding API request.\n\nChange-Id: Iae0d9cf38bda6f56b5a76a90a5cb38e11da4efdc\n","web_links":[{"name":"gitea","tooltip":"Open in GitWeb","url":"https://opendev.org/openstack/cinder-specs/commit/962d2c1a84c2d935d87ef157dc808ceeac23b794"}],"resolve_conflicts_web_links":[{"name":"gitea","tooltip":"Open in GitWeb","url":"https://opendev.org/openstack/cinder-specs/commit/962d2c1a84c2d935d87ef157dc808ceeac23b794"}]},"branch":"refs/heads/master"},"8e66e58950a2c358d40c991179b482830a8001bc":{"kind":"REWORK","_number":2,"created":"2019-05-22 12:10:28.000000000","uploader":{"_account_id":26458,"name":"Brin Zhang","email":"zhangbailin@inspur.com","username":"zhangbailin"},"ref":"refs/changes/21/660621/2","fetch":{"anonymous http":{"url":"https://review.opendev.org/openstack/cinder-specs","ref":"refs/changes/21/660621/2","commands":{"Checkout":"git fetch https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/2 \u0026\u0026 git checkout FETCH_HEAD","Cherry Pick":"git fetch https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/2 \u0026\u0026 git cherry-pick FETCH_HEAD","Format Patch":"git fetch https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/2 \u0026\u0026 git format-patch -1 --stdout FETCH_HEAD","Pull":"git pull https://review.opendev.org/openstack/cinder-specs refs/changes/21/660621/2"}}},"commit":{"parents":[{"commit":"8034f0d87808e3ee3f69fe955b42cec512db813f","subject":"OpenDev Migration Patch","web_links":[{"name":"gitea","tooltip":"Open in GitWeb","url":"https://opendev.org/openstack/cinder-specs/commit/8034f0d87808e3ee3f69fe955b42cec512db813f"}]}],"author":{"name":"zhangbailin","email":"zhangbailin@inspur.com","date":"2019-05-22 09:52:52.000000000","tz":480},"committer":{"name":"zhangbailin","email":"zhangbailin@inspur.com","date":"2019-05-22 12:07:32.000000000","tz":480},"subject":"Improve the cinder API docs","message":"Improve the cinder API docs\n\nThe current cinder list APIs can\u0027t display the request parameters of the\ninterface, which is unfriendly to the user or the developer. Why can\u0027t\nit be displayed clearly like the nova API, and it is easy to maintain.\nOf course, you can also do this in two steps. First, use the List\nresource filters API to get the filter fields of resources, and then use\nthe corresponding API request.\n\nImplements: blueprint improve-cinder-apis-docs\nChange-Id: Iae0d9cf38bda6f56b5a76a90a5cb38e11da4efdc\n","web_links":[{"name":"gitea","tooltip":"Open in GitWeb","url":"https://opendev.org/openstack/cinder-specs/commit/8e66e58950a2c358d40c991179b482830a8001bc"}],"resolve_conflicts_web_links":[{"name":"gitea","tooltip":"Open in GitWeb","url":"https://opendev.org/openstack/cinder-specs/commit/8e66e58950a2c358d40c991179b482830a8001bc"}]},"branch":"refs/heads/master"}},"requirements":[],"submit_records":[],"submit_requirements":[]}