02b9204aa1
As we discovered during implementation it wasn't a good idea of mine to make the request and response body a list on the top level. Neither the documentation tools nor python-neutronclient were prepared for non-dict request/response bodies. Another reason I suspect to always have dict-wrapped bodies is that it makes possible future changes to the request/response format a bit easier. Yet another reason is that the request/response body format in this change is now the exact same as it was used in the PUT /v2.0/routers/router-id request/response. Therefore clients wishing to use the new API only have to change the URL, but not the body of their requests. Since the api-def was already merged, this change just retroactively updates the spec to avoid possible future confusion between the spec and the api-ref. Change-Id: I3c7e9ab4ab6518eb1d30e3711a2d9571dfc2fa15 Partial-Bug: #1826396 |
||
|---|---|---|
| doc | ||
| images | ||
| misc | ||
| specs | ||
| tests | ||
| .gitignore | ||
| .gitreview | ||
| .stestr.conf | ||
| .zuul.yaml | ||
| LICENSE | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
README.rst
Team and repository tags
OpenStack Neutron Specifications
This git repository is used to hold approved design specifications for additions to the Neutron project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.
The layout of this repository is:
specs/<release>/You can find an example spec in specs/template.rst.
Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.
Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.
Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:
https://blueprints.launchpad.net/neutronPlease note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
https://wiki.openstack.org/wiki/BlueprintsFor more information about working with gerrit, see:
https://docs.openstack.org/infra/manual/developers.html#development-workflowTo validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:
$ toxAfter running tox, the documentation will be available
for viewing in HTML format in the doc/build/ directory.
Please do not check in the generated HTML files as a part of your
commit.