WADL to RST migration

This patch brings the Networking API Reference to a repository under the neutron stadium. It is a part of the effort described here [1]: As we discussed in the stadium evolution [2], we plan to have the API stuff in neutron-lib, so the API reference is hosted on neutron-lib as well. The goal of this patch is to import converted RST API references. Cleanup is planned once this patch is merged. [1] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan [2] https://review.openstack.org/312199 Change-Id: I6f2c4d476c31b252bfb181138505673f397639fc
2016-06-07 19:07:45 +09:00 · 2016-06-07 19:07:45 +09:00 · 0ac922ece1
commit 0ac922ece1
parent 0db5c13fc3
272 changed files with 17085 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -2,6 +2,7 @@ AUTHORS
 build/*
 build-stamp
 ChangeLog
+api-ref/build/
 cover/
 covhtml/
 dist/
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@ -0,0 +1,222 @@
+# -*- coding: utf-8 -*-
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# neutron documentation build configuration file, created by
+# sphinx-quickstart on Sat May  1 15:17:47 2010.
+#
+# This file is execfile()d with the current directory set to
+# its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import os
+import subprocess
+import sys
+import warnings
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('./'))
+
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+
+extensions = [
+    'os_api_ref',
+    'oslosphinx',
+]
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Compute API Reference'
+copyright = u'2010-present, OpenStack Foundation'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+from neutron_lib.version import version_info
+# The full version, including alpha/beta/rc tags.
+release = version_info.release_string()
+# The short X.Y version.
+version = version_info.version_string()
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# The reST default role (used for this markup: `text`) to use
+# for all documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = False
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for man page output ----------------------------------------------
+
+# Grouping the document tree for man pages.
+# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
+
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
+           "-n1"]
+try:
+    html_last_updated_fmt = subprocess.Popen(
+        git_cmd, stdout=subprocess.PIPE).communicate()[0]
+except Exception:
+    warnings.warn('Cannot get last updated time from git repository. '
+                  'Not setting "html_last_updated_fmt".')
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_use_modindex = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'neutrondoc'
+
+
+# -- Options for LaTeX output -------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+# latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+# latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index', 'Neutron.tex', u'OpenStack Networking API Documentation',
+     u'OpenStack Foundation', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+# latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_use_modindex = True
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@ -0,0 +1,9 @@
+=======================
+Networking Service APIs
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   v2/index
+   v2-ext/index
--- a/api-ref/source/samples/extensions/extension-show-response.json
+++ b/api-ref/source/samples/extensions/extension-show-response.json
@ -0,0 +1,9 @@
+{
+    "extension": {
+        "updated": "2013-02-03T10:00:00-00:00",
+        "name": "agent",
+        "links": [],
+        "alias": "agent",
+        "description": "The agent management extension."
+    }
+}
--- a/api-ref/source/samples/extensions/extensions-list-response.json
+++ b/api-ref/source/samples/extensions/extensions-list-response.json
@ -0,0 +1,123 @@
+{
+    "extensions": [
+        {
+            "updated": "2013-01-20T00:00:00-00:00",
+            "name": "Neutron Service Type Management",
+            "links": [],
+            "alias": "service-type",
+            "description": "API for retrieving service providers for Neutron advanced services"
+        },
+        {
+            "updated": "2012-10-05T10:00:00-00:00",
+            "name": "security-group",
+            "links": [],
+            "alias": "security-group",
+            "description": "The security groups extension."
+        },
+        {
+            "updated": "2013-02-07T10:00:00-00:00",
+            "name": "L3 Agent Scheduler",
+            "links": [],
+            "alias": "l3_agent_scheduler",
+            "description": "Schedule routers among l3 agents"
+        },
+        {
+            "updated": "2013-02-07T10:00:00-00:00",
+            "name": "Loadbalancer Agent Scheduler",
+            "links": [],
+            "alias": "lbaas_agent_scheduler",
+            "description": "Schedule pools among lbaas agents"
+        },
+        {
+            "updated": "2013-03-28T10:00:00-00:00",
+            "name": "Neutron L3 Configurable external gateway mode",
+            "links": [],
+            "alias": "ext-gw-mode",
+            "description": "Extension of the router abstraction for specifying whether SNAT should occur on the external gateway"
+        },
+        {
+            "updated": "2014-02-03T10:00:00-00:00",
+            "name": "Port Binding",
+            "links": [],
+            "alias": "binding",
+            "description": "Expose port bindings of a virtual port to external application"
+        },
+        {
+            "updated": "2012-09-07T10:00:00-00:00",
+            "name": "Provider Network",
+            "links": [],
+            "alias": "provider",
+            "description": "Expose mapping of virtual networks to physical networks"
+        },
+        {
+            "updated": "2013-02-03T10:00:00-00:00",
+            "name": "agent",
+            "links": [],
+            "alias": "agent",
+            "description": "The agent management extension."
+        },
+        {
+            "updated": "2012-07-29T10:00:00-00:00",
+            "name": "Quota management support",
+            "links": [],
+            "alias": "quotas",
+            "description": "Expose functions for quotas management per tenant"
+        },
+        {
+            "updated": "2013-02-07T10:00:00-00:00",
+            "name": "DHCP Agent Scheduler",
+            "links": [],
+            "alias": "dhcp_agent_scheduler",
+            "description": "Schedule networks among dhcp agents"
+        },
+        {
+            "updated": "2013-06-27T10:00:00-00:00",
+            "name": "Multi Provider Network",
+            "links": [],
+            "alias": "multi-provider",
+            "description": "Expose mapping of virtual networks to multiple physical networks"
+        },
+        {
+            "updated": "2013-01-14T10:00:00-00:00",
+            "name": "Neutron external network",
+            "links": [],
+            "alias": "external-net",
+            "description": "Adds external network attribute to network resource."
+        },
+        {
+            "updated": "2012-07-20T10:00:00-00:00",
+            "name": "Neutron L3 Router",
+            "links": [],
+            "alias": "router",
+            "description": "Router abstraction for basic L3 forwarding between L2 Neutron networks and access to external networks via a NAT gateway."
+        },
+        {
+            "updated": "2013-07-23T10:00:00-00:00",
+            "name": "Allowed Address Pairs",
+            "links": [],
+            "alias": "allowed-address-pairs",
+            "description": "Provides allowed address pairs"
+        },
+        {
+            "updated": "2013-03-17T12:00:00-00:00",
+            "name": "Neutron Extra DHCP opts",
+            "links": [],
+            "alias": "extra_dhcp_opt",
+            "description": "Extra options configuration for DHCP. For example PXE boot options to DHCP clients can be specified (e.g. tftp-server, server-ip-address, bootfile-name)"
+        },
+        {
+            "updated": "2012-10-07T10:00:00-00:00",
+            "name": "LoadBalancing service",
+            "links": [],
+            "alias": "lbaas",
+            "description": "Extension for LoadBalancing service"
+        },
+        {
+            "updated": "2013-02-01T10:00:00-00:00",
+            "name": "Neutron Extra Route",
+            "links": [],
+            "alias": "extraroute",
+            "description": "Extra routes configuration for L3 router"
+        }
+    ]
+}
--- a/api-ref/source/samples/firewalls/firewall-create-request.json
+++ b/api-ref/source/samples/firewalls/firewall-create-request.json
@ -0,0 +1,6 @@
+{
+    "firewall": {
+        "admin_state_up": true,
+        "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-create-response.json
+++ b/api-ref/source/samples/firewalls/firewall-create-response.json
@ -0,0 +1,14 @@
+{
+    "firewall": {
+        "admin_state_up": true,
+        "description": "",
+        "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+        "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
+        "name": "",
+        "status": "PENDING_CREATE",
+        "router_ids": [
+            "650bfd2f-7766-4a0d-839f-218f33e16998"
+        ],
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-policies-list-response.json
+++ b/api-ref/source/samples/firewalls/firewall-policies-list-response.json
@ -0,0 +1,15 @@
+{
+    "firewall_policies": [
+        {
+            "audited": false,
+            "description": "",
+            "firewall_rules": [
+                "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+            ],
+            "id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+            "name": "test-policy",
+            "shared": false,
+            "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+        }
+    ]
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-create-request.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-create-request.json
@ -0,0 +1,8 @@
+{
+    "firewall_policy": {
+        "firewall_rules": [
+            "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+        ],
+        "name": "test-policy"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-create-response.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-create-response.json
@ -0,0 +1,13 @@
+{
+    "firewall_policy": {
+        "audited": false,
+        "description": "",
+        "firewall_rules": [
+            "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+        ],
+        "id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+        "name": "test-policy",
+        "shared": false,
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-insert-rule-request.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-insert-rule-request.json
@ -0,0 +1,5 @@
+{
+    "firewall_rule_id": "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692",
+    "insert_after": "a08ef905-0ff6-4784-8374-175fffe7dade",
+    "insert_before": ""
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-insert-rule-response.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-insert-rule-response.json
@ -0,0 +1,14 @@
+{
+    "audited": false,
+    "description": "",
+    "firewall_list": [],
+    "firewall_rules": [
+        "a08ef905-0ff6-4784-8374-175fffe7dade",
+        "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692",
+        "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+    ],
+    "id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+    "name": "test-policy",
+    "shared": false,
+    "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-remove-rule-request.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-remove-rule-request.json
@ -0,0 +1,3 @@
+{
+    "firewall_rule_id": "7bc34b8c-8d3b-4ada-a9c8-1f4c11c65692"
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-remove-rule-response.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-remove-rule-response.json
@ -0,0 +1,13 @@
+{
+    "audited": false,
+    "description": "",
+    "firewall_list": [],
+    "firewall_rules": [
+        "a08ef905-0ff6-4784-8374-175fffe7dade",
+        "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+    ],
+    "id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+    "name": "test-policy",
+    "shared": false,
+    "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-show-response.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-show-response.json
@ -0,0 +1,13 @@
+{
+    "firewall_policy": {
+        "audited": false,
+        "description": "",
+        "firewall_rules": [
+            "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+        ],
+        "id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+        "name": "test-policy",
+        "shared": false,
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-update-request.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-update-request.json
@ -0,0 +1,8 @@
+{
+    "firewall_policy": {
+        "firewall_rules": [
+            "a08ef905-0ff6-4784-8374-175fffe7dade",
+            "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+        ]
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-policy-update-response.json
+++ b/api-ref/source/samples/firewalls/firewall-policy-update-response.json
@ -0,0 +1,14 @@
+{
+    "firewall_policy": {
+        "audited": false,
+        "description": "",
+        "firewall_rules": [
+            "a08ef905-0ff6-4784-8374-175fffe7dade",
+            "8722e0e0-9cc9-4490-9660-8c9a5732fbb0"
+        ],
+        "id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+        "name": "test-policy",
+        "shared": false,
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-rule-create-request.json
+++ b/api-ref/source/samples/firewalls/firewall-rule-create-request.json
@ -0,0 +1,9 @@
+{
+    "firewall_rule": {
+        "action": "allow",
+        "destination_port": "80",
+        "enabled": true,
+        "name": "ALLOW_HTTP",
+        "protocol": "tcp"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-rule-create-response.json
+++ b/api-ref/source/samples/firewalls/firewall-rule-create-response.json
@ -0,0 +1,19 @@
+{
+    "firewall_rule": {
+        "action": "allow",
+        "description": "",
+        "destination_ip_address": null,
+        "destination_port": "80",
+        "enabled": true,
+        "firewall_policy_id": null,
+        "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
+        "ip_version": 4,
+        "name": "ALLOW_HTTP",
+        "position": null,
+        "protocol": "tcp",
+        "shared": false,
+        "source_ip_address": null,
+        "source_port": null,
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-rule-show-response.json
+++ b/api-ref/source/samples/firewalls/firewall-rule-show-response.json
@ -0,0 +1,19 @@
+{
+    "firewall_rule": {
+        "action": "allow",
+        "description": "",
+        "destination_ip_address": null,
+        "destination_port": "80",
+        "enabled": true,
+        "firewall_policy_id": null,
+        "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
+        "ip_version": 4,
+        "name": "ALLOW_HTTP",
+        "position": null,
+        "protocol": "tcp",
+        "shared": false,
+        "source_ip_address": null,
+        "source_port": null,
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-rule-update-request.json
+++ b/api-ref/source/samples/firewalls/firewall-rule-update-request.json
@ -0,0 +1,5 @@
+{
+    "firewall_rule": {
+        "shared": "true"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-rule-update-response.json
+++ b/api-ref/source/samples/firewalls/firewall-rule-update-response.json
@ -0,0 +1,19 @@
+{
+    "firewall_rule": {
+        "action": "allow",
+        "description": "",
+        "destination_ip_address": null,
+        "destination_port": "80",
+        "enabled": true,
+        "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+        "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
+        "ip_version": 4,
+        "name": "ALLOW_HTTP",
+        "position": 1,
+        "protocol": "tcp",
+        "shared": true,
+        "source_ip_address": null,
+        "source_port": null,
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-rules-list-response.json
+++ b/api-ref/source/samples/firewalls/firewall-rules-list-response.json
@ -0,0 +1,21 @@
+{
+    "firewall_rules": [
+        {
+            "action": "allow",
+            "description": "",
+            "destination_ip_address": null,
+            "destination_port": "80",
+            "enabled": true,
+            "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+            "id": "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
+            "ip_version": 4,
+            "name": "ALLOW_HTTP",
+            "position": 1,
+            "protocol": "tcp",
+            "shared": false,
+            "source_ip_address": null,
+            "source_port": null,
+            "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+        }
+    ]
+}
--- a/api-ref/source/samples/firewalls/firewall-show-response.json
+++ b/api-ref/source/samples/firewalls/firewall-show-response.json
@ -0,0 +1,14 @@
+{
+    "firewall": {
+        "admin_state_up": true,
+        "description": "",
+        "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+        "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
+        "name": "",
+        "status": "ACTIVE",
+        "router_ids": [
+            "650bfd2f-7766-4a0d-839f-218f33e16998"
+        ],
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-update-request.json
+++ b/api-ref/source/samples/firewalls/firewall-update-request.json
@ -0,0 +1,5 @@
+{
+    "firewall": {
+        "admin_state_up": "false"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewall-update-response.json
+++ b/api-ref/source/samples/firewalls/firewall-update-response.json
@ -0,0 +1,14 @@
+{
+    "firewall": {
+        "admin_state_up": false,
+        "description": "",
+        "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+        "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
+        "name": "",
+        "status": "PENDING_UPDATE",
+        "router_ids": [
+            "650bfd2f-7766-4a0d-839f-218f33e16998"
+        ],
+        "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+    }
+}
--- a/api-ref/source/samples/firewalls/firewalls-list-response.json
+++ b/api-ref/source/samples/firewalls/firewalls-list-response.json
@ -0,0 +1,16 @@
+{
+    "firewalls": [
+        {
+            "admin_state_up": true,
+            "description": "",
+            "firewall_policy_id": "c69933c1-b472-44f9-8226-30dc4ffd454c",
+            "id": "3b0ef8f4-82c7-44d4-a4fb-6177f9a21977",
+            "name": "",
+            "status": "ACTIVE",
+            "router_ids": [
+                "650bfd2f-7766-4a0d-839f-218f33e16998"
+            ],
+            "tenant_id": "45977fa2dbd7482098dd68d0d8970117"
+        }
+    ]
+}
--- a/api-ref/source/samples/flavors/flavor-associate-request.json
+++ b/api-ref/source/samples/flavors/flavor-associate-request.json
@ -0,0 +1,5 @@
+{
+    "service_profile": {
+        "id": "4e5b9191-ffbe-4f7a-b112-2db98232fd32"
+    }
+}
--- a/api-ref/source/samples/flavors/flavor-associate-response.json
+++ b/api-ref/source/samples/flavors/flavor-associate-response.json
@ -0,0 +1,5 @@
+{
+    "service_profile": {
+        "id": "7fc0581b-4509-49e1-90eb-c953c877fa4c"
+    }
+}
--- a/api-ref/source/samples/flavors/flavor-create-request.json
+++ b/api-ref/source/samples/flavors/flavor-create-request.json
@ -0,0 +1,8 @@
+{
+    "flavor": {
+        "service_type": "LOADBALANCERV2",
+        "enabled": true,
+        "name": "dummy",
+        "description": "Dummy flavor"
+    }
+}
--- a/api-ref/source/samples/flavors/flavor-create-response.json
+++ b/api-ref/source/samples/flavors/flavor-create-response.json
@ -0,0 +1,10 @@
+{
+    "flavor": {
+        "id": "7fc0581b-4509-49e1-90eb-c953c877fa4c",
+        "name": "dummy",
+        "service_type": "LOADBALANCERV2",
+        "description": "Dummy flavor",
+        "enabled": true,
+        "service_profiles": []
+    }
+}
--- a/api-ref/source/samples/flavors/flavor-show-response.json
+++ b/api-ref/source/samples/flavors/flavor-show-response.json
@ -0,0 +1,10 @@
+{
+    "flavor": {
+        "description": "",
+        "enabled": true,
+        "service_profiles": [],
+        "service_type": "LOADBALANCERV2",
+        "id": "f7b14d9a-b0dc-4fbe-bb14-a0f4970a69e0",
+        "name": "dummy"
+    }
+}
--- a/api-ref/source/samples/flavors/flavor-update-request.json
+++ b/api-ref/source/samples/flavors/flavor-update-request.json
@ -0,0 +1,7 @@
+{
+    "flavor": {
+        "enabled": false,
+        "name": "newname",
+        "description": "New description"
+    }
+}
--- a/api-ref/source/samples/flavors/flavor-update-response.json
+++ b/api-ref/source/samples/flavors/flavor-update-response.json
@ -0,0 +1,10 @@
+{
+    "flavor": {
+        "description": "New description",
+        "enabled": false,
+        "service_profiles": [],
+        "service_type": "LOADBALANCERV2",
+        "id": "7fc0581b-4509-49e1-90eb-c953c877fa4c",
+        "name": "newname"
+    }
+}
--- a/api-ref/source/samples/flavors/flavors-list-response.json
+++ b/api-ref/source/samples/flavors/flavors-list-response.json
@ -0,0 +1,12 @@
+{
+    "flavors": [
+        {
+            "description": "",
+            "enabled": true,
+            "service_profiles": [],
+            "service_type": "LOADBALANCERV2",
+            "id": "f7b14d9a-b0dc-4fbe-bb14-a0f4970a69e0",
+            "name": "dummy"
+        }
+    ]
+}
--- a/api-ref/source/samples/flavors/service-profile-create-request.json
+++ b/api-ref/source/samples/flavors/service-profile-create-request.json
@ -0,0 +1,8 @@
+{
+    "service_profile": {
+        "enabled": "true",
+        "driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
+        "description": "Dummy profile",
+        "metainfo": "{'foo': 'bar'}"
+    }
+}
--- a/api-ref/source/samples/flavors/service-profile-create-response.json
+++ b/api-ref/source/samples/flavors/service-profile-create-response.json
@ -0,0 +1,9 @@
+{
+    "service_profile": {
+        "enabled": true,
+        "metainfo": "{'foo': 'bar'}",
+        "driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
+        "id": "7c793e5f-9b64-44e0-8b1f-902e59c85a01",
+        "description": "Dummy profile"
+    }
+}
--- a/api-ref/source/samples/flavors/service-profile-show-response.json
+++ b/api-ref/source/samples/flavors/service-profile-show-response.json
@ -0,0 +1,9 @@
+{
+    "service_profile": {
+        "enabled": true,
+        "metainfo": "{'foo': 'bar'}",
+        "driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
+        "id": "7c793e5f-9b64-44e0-8b1f-902e59c85a01",
+        "description": "Dummy profile"
+    }
+}
--- a/api-ref/source/samples/flavors/service-profile-update-request.json
+++ b/api-ref/source/samples/flavors/service-profile-update-request.json
@ -0,0 +1,8 @@
+{
+    "service_profile": {
+        "enabled": false,
+        "driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
+        "description": "New description",
+        "metainfo": "{'new': 'info'}"
+    }
+}
--- a/api-ref/source/samples/flavors/service-profile-update-response.json
+++ b/api-ref/source/samples/flavors/service-profile-update-response.json
@ -0,0 +1,9 @@
+{
+    "service_profile": {
+        "enabled": false,
+        "metainfo": "{'new': 'info'}",
+        "driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
+        "id": "7c793e5f-9b64-44e0-8b1f-902e59c85a01",
+        "description": "New description"
+    }
+}
--- a/api-ref/source/samples/flavors/service-profiles-list-response.json
+++ b/api-ref/source/samples/flavors/service-profiles-list-response.json
@ -0,0 +1,18 @@
+{
+    "service_profiles": [
+        {
+            "id": "4e5b9191-ffbe-4f7a-b112-2db98232fd32",
+            "enabled": true,
+            "driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
+            "description": "",
+            "metainfo": ""
+        },
+        {
+            "id": "684322c5-703a-48a2-8138-34b99942a7ef",
+            "enabled": true,
+            "driver": "neutron_lbaas.drivers.octavia.driver.OctaviaDriver",
+            "description": "",
+            "metainfo": ""
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/healthmonitor-associate-request.json
+++ b/api-ref/source/samples/lbaas/healthmonitor-associate-request.json
@ -0,0 +1,5 @@
+{
+    "health_monitor": {
+        "id": "b624decf-d5d3-4c66-9a3d-f047e7786181"
+    }
+}
--- a/api-ref/source/samples/lbaas/healthmonitor-associate-response.json
+++ b/api-ref/source/samples/lbaas/healthmonitor-associate-response.json
@ -0,0 +1,3 @@
+{
+    "health_monitor": {}
+}
--- a/api-ref/source/samples/lbaas/healthmonitor-create-request.json
+++ b/api-ref/source/samples/lbaas/healthmonitor-create-request.json
@ -0,0 +1,12 @@
+{
+    "health_monitor": {
+        "admin_state_up": true,
+        "delay": "1",
+        "expected_codes": "200,201,202",
+        "http_method": "GET",
+        "max_retries": 5,
+        "timeout": 1,
+        "type": "HTTP",
+        "url_path": "/index.html"
+    }
+}
--- a/api-ref/source/samples/lbaas/healthmonitor-create-response.json
+++ b/api-ref/source/samples/lbaas/healthmonitor-create-response.json
@ -0,0 +1,15 @@
+{
+    "health_monitor": {
+        "admin_state_up": true,
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "delay": 1,
+        "expected_codes": "200,201,202",
+        "max_retries": 5,
+        "http_method": "GET",
+        "timeout": 1,
+        "pools": [],
+        "url_path": "/index.html",
+        "type": "HTTP",
+        "id": "b7633ade-24dc-4d72-8475-06aa22be5412"
+    }
+}
--- a/api-ref/source/samples/lbaas/healthmonitor-show-response.json
+++ b/api-ref/source/samples/lbaas/healthmonitor-show-response.json
@ -0,0 +1,21 @@
+{
+    "health_monitor": {
+        "admin_state_up": true,
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "delay": 1,
+        "expected_codes": "200,201,202",
+        "max_retries": 5,
+        "http_method": "GET",
+        "timeout": 1,
+        "pools": [
+            {
+                "status": "ACTIVE",
+                "status_description": null,
+                "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+            }
+        ],
+        "url_path": "/index.html",
+        "type": "HTTP",
+        "id": "b7633ade-24dc-4d72-8475-06aa22be5412"
+    }
+}
--- a/api-ref/source/samples/lbaas/healthmonitor-update-request.json
+++ b/api-ref/source/samples/lbaas/healthmonitor-update-request.json
@ -0,0 +1,11 @@
+{
+    "health_monitor": {
+        "admin_state_up": false,
+        "delay": "2",
+        "expected_codes": "200",
+        "http_method": "POST",
+        "max_retries": 2,
+        "timeout": 2,
+        "url_path": "/page.html"
+    }
+}
--- a/api-ref/source/samples/lbaas/healthmonitor-update-response.json
+++ b/api-ref/source/samples/lbaas/healthmonitor-update-response.json
@ -0,0 +1,21 @@
+{
+    "health_monitor": {
+        "admin_state_up": false,
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "delay": 2,
+        "expected_codes": "200",
+        "max_retries": 2,
+        "http_method": "POST",
+        "timeout": 2,
+        "pools": [
+            {
+                "status": "ACTIVE",
+                "status_description": null,
+                "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+            }
+        ],
+        "url_path": "/page.html",
+        "type": "HTTP",
+        "id": "b7633ade-24dc-4d72-8475-06aa22be5412"
+    }
+}
--- a/api-ref/source/samples/lbaas/healthmonitors-list-response.json
+++ b/api-ref/source/samples/lbaas/healthmonitors-list-response.json
@ -0,0 +1,23 @@
+{
+    "health_monitors": [
+        {
+            "admin_state_up": true,
+            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+            "delay": 1,
+            "expected_codes": "200,201,202",
+            "max_retries": 5,
+            "http_method": "GET",
+            "timeout": 1,
+            "pools": [
+                {
+                    "status": "ACTIVE",
+                    "status_description": null,
+                    "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+                }
+            ],
+            "url_path": "/index.html",
+            "type": "HTTP",
+            "id": "b7633ade-24dc-4d72-8475-06aa22be5412"
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/listener-create-request.json
+++ b/api-ref/source/samples/lbaas/listener-create-request.json
@ -0,0 +1,16 @@
+{
+    "listener": {
+        "admin_state_up": true,
+        "connection_limit": 100,
+        "description": "listener one",
+        "loadbalancer_id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "name": "listener1",
+        "protocol": "HTTP",
+        "protocol_port": "80",
+        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "sni_container_refs": [
+            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
+            "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
+        ]
+    }
+}
--- a/api-ref/source/samples/lbaas/listener-create-response.json
+++ b/api-ref/source/samples/lbaas/listener-create-response.json
@ -0,0 +1,23 @@
+{
+    "listener": {
+        "admin_state_up": true,
+        "connection_limit": 100,
+        "default_pool_id": null,
+        "description": "listener one",
+        "id": "39de4d56-d663-46e5-85a1-5b9d5fa17829",
+        "loadbalancers": [
+            {
+                "id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c"
+            }
+        ],
+        "name": "listener1",
+        "protocol": "HTTP",
+        "protocol_port": 80,
+        "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
+        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "sni_container_refs": [
+            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
+            "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
+        ]
+    }
+}
--- a/api-ref/source/samples/lbaas/listener-show-response.json
+++ b/api-ref/source/samples/lbaas/listener-show-response.json
@ -0,0 +1,23 @@
+{
+    "listener": {
+        "admin_state_up": true,
+        "connection_limit": 100,
+        "default_pool_id": null,
+        "description": "",
+        "id": "35cb8516-1173-4035-8dae-0dae3453f37f",
+        "loadbalancers": [
+            {
+                "id": "a9729389-6147-41a3-ab22-a24aed8692b2"
+            }
+        ],
+        "name": "",
+        "protocol": "HTTP",
+        "protocol_port": 80,
+        "tenant_id": "3e4d8bec50a845fcb09e03a4375c691d",
+        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "sni_container_refs": [
+            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
+            "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
+        ]
+    }
+}
--- a/api-ref/source/samples/lbaas/listener-update-request.json
+++ b/api-ref/source/samples/lbaas/listener-update-request.json
@ -0,0 +1,13 @@
+{
+    "listener": {
+        "admin_state_up": false,
+        "connection_limit": 200,
+        "description": "listener two",
+        "name": "listener2",
+        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "sni_container_refs": [
+            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
+            "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
+        ]
+    }
+}
--- a/api-ref/source/samples/lbaas/listener-update-response.json
+++ b/api-ref/source/samples/lbaas/listener-update-response.json
@ -0,0 +1,23 @@
+{
+    "listener": {
+        "admin_state_up": false,
+        "connection_limit": 200,
+        "default_pool_id": null,
+        "description": "listener two",
+        "id": "39de4d56-d663-46e5-85a1-5b9d5fa17829",
+        "loadbalancers": [
+            {
+                "id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c"
+            }
+        ],
+        "name": "listener2",
+        "protocol": "HTTP",
+        "protocol_port": 80,
+        "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
+        "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "sni_container_refs": [
+            "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
+            "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
+        ]
+    }
+}
--- a/api-ref/source/samples/lbaas/listeners-list-response.json
+++ b/api-ref/source/samples/lbaas/listeners-list-response.json
@ -0,0 +1,25 @@
+{
+    "listeners": [
+        {
+            "admin_state_up": true,
+            "connection_limit": 100,
+            "default_pool_id": null,
+            "description": "",
+            "id": "35cb8516-1173-4035-8dae-0dae3453f37f",
+            "loadbalancers": [
+                {
+                    "id": "a9729389-6147-41a3-ab22-a24aed8692b2"
+                }
+            ],
+            "name": "",
+            "protocol": "HTTP",
+            "protocol_port": 80,
+            "tenant_id": "3e4d8bec50a845fcb09e03a4375c691d",
+            "default_tls_container_ref": "https://barbican.endpoint/containers/a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+            "sni_container_refs": [
+                "https://barbican.endpoint/containers/b36c20d0-18e9-42ce-88fd-82a35977ee8d",
+                "https://barbican.endpoint/containers/c36c20d0-18e9-42ce-88fd-82a35977ee8e"
+            ]
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-create-request.json
+++ b/api-ref/source/samples/lbaas/loadbalancer-create-request.json
@ -0,0 +1,11 @@
+{
+    "loadbalancer": {
+        "name": "loadbalancer1",
+        "description": "simple lb",
+        "tenant_id": "b7c1a69e88bf4b21a8148f787aef2081",
+        "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
+        "vip_address": "10.0.0.4",
+        "admin_state_up": true,
+        "flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04"
+    }
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-create-response.json
+++ b/api-ref/source/samples/lbaas/loadbalancer-create-response.json
@ -0,0 +1,16 @@
+{
+    "loadbalancer": {
+        "admin_state_up": true,
+        "description": "simple lb",
+        "id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "listeners": [],
+        "name": "loadbalancer1",
+        "operating_status": "ONLINE",
+        "provisioning_status": "ACTIVE",
+        "tenant_id": "b7c1a69e88bf4b21a8148f787aef2081",
+        "vip_address": "10.0.0.4",
+        "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
+        "flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04",
+        "provider": "sample_provider"
+    }
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-delete-response.json
+++ b/api-ref/source/samples/lbaas/loadbalancer-delete-response.json
@ -0,0 +1,8 @@
+{
+    "loadbalancer": {
+        "active_connections": 0,
+        "total_connections": 0,
+        "bytes_in": 0,
+        "bytes_out": 0
+    }
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-show-response.json
+++ b/api-ref/source/samples/lbaas/loadbalancer-show-response.json
@ -0,0 +1,14 @@
+{
+    "loadbalancer": {
+        "description": "simple lb",
+        "admin_state_up": true,
+        "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
+        "provisioning_status": "ACTIVE",
+        "listeners": [],
+        "vip_address": "10.0.0.2",
+        "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
+        "id": "a9729389-6147-41a3-ab22-a24aed8692b2",
+        "operating_status": "ONLINE",
+        "name": "loadbalancer1"
+    }
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-status-tree.json
+++ b/api-ref/source/samples/lbaas/loadbalancer-status-tree.json
@ -0,0 +1,47 @@
+{
+    "statuses": {
+        "loadbalancer": {
+            "name": "lb1",
+            "listeners": [
+                {
+                    "pools": [
+                        {
+                            "name": "pool1",
+                            "provisioning_status": "ACTIVE",
+                            "health_monitor": {
+                                "type": "HTTP",
+                                "id": "90f7c765-0bc9-47c4-8513-4cc0c264c8f8",
+                                "provisioning_status": "ACTIVE"
+                            },
+                            "members": [
+                                {
+                                    "address": "10.0.0.4",
+                                    "protocol_port": 80,
+                                    "id": "32723bee-2484-4de3-b6fc-c0b98d35fc84",
+                                    "operating_status": "ONLINE",
+                                    "provisioning_status": "ACTIVE"
+                                },
+                                {
+                                    "address": "10.0.0.3",
+                                    "protocol_port": 80,
+                                    "id": "173b8164-0c9a-43ec-ab33-4ae0e7a8f863",
+                                    "operating_status": "ONLINE",
+                                    "provisioning_status": "ACTIVE"
+                                }
+                            ],
+                            "id": "ae6f93b8-a3f6-46cd-bb18-c2ab0308abf7",
+                            "operating_status": "ONLINE"
+                        }
+                    ],
+                    "name": "listener1",
+                    "id": "c2a41fbe-b70a-4645-bb11-4d3c28f23a25",
+                    "operating_status": "ONLINE",
+                    "provisioning_status": "ACTIVE"
+                }
+            ],
+            "id": "a4c19566-6f81-4c96-ac11-33954a9825a2",
+            "operating_status": "ONLINE",
+            "provisioning_status": "ACTIVE"
+        }
+    }
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-update-request.json
+++ b/api-ref/source/samples/lbaas/loadbalancer-update-request.json
@ -0,0 +1,7 @@
+{
+    "loadbalancer": {
+        "admin_state_up": false,
+        "description": "simple lb2",
+        "name": "loadbalancer2"
+    }
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-update-response.json
+++ b/api-ref/source/samples/lbaas/loadbalancer-update-response.json
@ -0,0 +1,14 @@
+{
+    "loadbalancer": {
+        "admin_state_up": false,
+        "description": "simple lb2",
+        "id": "a36c20d0-18e9-42ce-88fd-82a35977ee8c",
+        "listeners": [],
+        "name": "loadbalancer2",
+        "operating_status": "ONLINE",
+        "provisioning_status": "PENDING_UPDATE",
+        "tenant_id": "b7c1a69e88bf4b21a8148f787aef2081",
+        "vip_address": "10.0.0.4",
+        "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2"
+    }
+}
--- a/api-ref/source/samples/lbaas/loadbalancer-update-response.txt
+++ b/api-ref/source/samples/lbaas/loadbalancer-update-response.txt
@ -0,0 +1,4 @@
+#!wiki caution
+Note
+
+A Load Balancer that is does not have a provisioning_status of ACTIVE  cannot be updated.
--- a/api-ref/source/samples/lbaas/loadbalancers-list-response.json
+++ b/api-ref/source/samples/lbaas/loadbalancers-list-response.json
@ -0,0 +1,16 @@
+{
+    "loadbalancers": [
+        {
+            "description": "simple lb",
+            "admin_state_up": true,
+            "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
+            "provisioning_status": "ACTIVE",
+            "listeners": [],
+            "vip_address": "10.0.0.2",
+            "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
+            "id": "a9729389-6147-41a3-ab22-a24aed8692b2",
+            "operating_status": "ONLINE",
+            "name": "loadbalancer1"
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/member-create-request.json
+++ b/api-ref/source/samples/lbaas/member-create-request.json
@ -0,0 +1,9 @@
+{
+    "member": {
+        "address": "10.0.0.22",
+        "admin_state_up": true,
+        "protocol_port": "90",
+        "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+        "weight": "1"
+    }
+}
--- a/api-ref/source/samples/lbaas/member-create-response.json
+++ b/api-ref/source/samples/lbaas/member-create-response.json
@ -0,0 +1,13 @@
+{
+    "member": {
+        "admin_state_up": true,
+        "status": "PENDING_CREATE",
+        "status_description": null,
+        "weight": 1,
+        "address": "10.0.1.22",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "protocol_port": 90,
+        "id": "cf024846-7516-4e3a-b0fb-6590322c836f",
+        "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+    }
+}
--- a/api-ref/source/samples/lbaas/member-show-response.json
+++ b/api-ref/source/samples/lbaas/member-show-response.json
@ -0,0 +1,13 @@
+{
+    "member": {
+        "admin_state_up": true,
+        "status": "ACTIVE",
+        "status_description": null,
+        "weight": 1,
+        "address": "10.0.1.22",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "protocol_port": 90,
+        "id": "cf024846-7516-4e3a-b0fb-6590322c836f",
+        "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+    }
+}
--- a/api-ref/source/samples/lbaas/member-update-request.json
+++ b/api-ref/source/samples/lbaas/member-update-request.json
@ -0,0 +1,5 @@
+{
+    "member": {
+        "weight": 5
+    }
+}
--- a/api-ref/source/samples/lbaas/member-update-response.json
+++ b/api-ref/source/samples/lbaas/member-update-response.json
@ -0,0 +1,13 @@
+{
+    "member": {
+        "admin_state_up": true,
+        "status": "PENDING_UPDATE",
+        "status_description": null,
+        "weight": 5,
+        "address": "10.0.1.22",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "protocol_port": 90,
+        "id": "cf024846-7516-4e3a-b0fb-6590322c836f",
+        "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+    }
+}
--- a/api-ref/source/samples/lbaas/members-list-response.json
+++ b/api-ref/source/samples/lbaas/members-list-response.json
@ -0,0 +1,15 @@
+{
+    "members": [
+        {
+            "admin_state_up": true,
+            "status": "ACTIVE",
+            "status_description": null,
+            "weight": 1,
+            "address": "10.0.1.22",
+            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+            "protocol_port": 90,
+            "id": "cf024846-7516-4e3a-b0fb-6590322c836f",
+            "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332"
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/pool-create-request.json
+++ b/api-ref/source/samples/lbaas/pool-create-request.json
@ -0,0 +1,10 @@
+{
+    "pool": {
+        "admin_state_up": true,
+        "description": "simple pool",
+        "lb_algorithm": "ROUND_ROBIN",
+        "name": "my-pool",
+        "protocol": "HTTP",
+        "subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d"
+    }
+}
--- a/api-ref/source/samples/lbaas/pool-create-response.json
+++ b/api-ref/source/samples/lbaas/pool-create-response.json
@ -0,0 +1,19 @@
+{
+    "pool": {
+        "status": "PENDING_CREATE",
+        "lb_algorithm": "ROUND_ROBIN",
+        "protocol": "HTTP",
+        "description": "simple pool",
+        "health_monitors": [],
+        "members": [],
+        "status_description": null,
+        "id": "af95e0ce-8a26-4f29-9524-db41e7769c73",
+        "vip_id": null,
+        "name": "my-pool",
+        "admin_state_up": true,
+        "subnet_id": "e301aed0-d9e7-498a-977c-1bbfaf14ed5d",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "health_monitors_status": [],
+        "provider": "haproxy"
+    }
+}
--- a/api-ref/source/samples/lbaas/pool-list-resp.json
+++ b/api-ref/source/samples/lbaas/pool-list-resp.json
@ -0,0 +1,20 @@
+{
+    "pools": [
+        {
+            "admin_state_up": true,
+            "description": "simple pool",
+            "healthmonitor_id": null,
+            "id": "4c0a0a5f-cf8f-44b7-b912-957daa8ce5e5",
+            "lb_algorithm": "ROUND_ROBIN",
+            "listeners": [
+                {
+                    "id": "35cb8516-1173-4035-8dae-0dae3453f37f"
+                }
+            ],
+            "members": [],
+            "name": "pool1",
+            "protocol": "HTTP",
+            "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c"
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/pool-members-list-response.json
+++ b/api-ref/source/samples/lbaas/pool-members-list-response.json
@ -0,0 +1,13 @@
+{
+    "members": [
+        {
+            "address": "10.0.0.8",
+            "admin_state_up": true,
+            "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313",
+            "protocol_port": 80,
+            "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2",
+            "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
+            "weight": 1
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/pool-show-response.json
+++ b/api-ref/source/samples/lbaas/pool-show-response.json
@ -0,0 +1,29 @@
+{
+    "pool": {
+        "status": "ACTIVE",
+        "lb_algorithm": "ROUND_ROBIN",
+        "protocol": "HTTP",
+        "description": "",
+        "health_monitors": [
+            "b7633ade-24dc-4d72-8475-06aa22be5412"
+        ],
+        "members": [
+            "cf024846-7516-4e3a-b0fb-6590322c836f"
+        ],
+        "status_description": null,
+        "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+        "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
+        "name": "pool1",
+        "admin_state_up": true,
+        "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "health_monitors_status": [
+            {
+                "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
+                "status": "ACTIVE",
+                "status_description": null
+            }
+        ],
+        "provider": "haproxy"
+    }
+}
--- a/api-ref/source/samples/lbaas/pool-update-request.json
+++ b/api-ref/source/samples/lbaas/pool-update-request.json
@ -0,0 +1,5 @@
+{
+    "pool": {
+        "name": "SuperPool"
+    }
+}
--- a/api-ref/source/samples/lbaas/pool-update-response.json
+++ b/api-ref/source/samples/lbaas/pool-update-response.json
@ -0,0 +1,29 @@
+{
+    "pool": {
+        "status": "PENDING_UPDATE",
+        "lb_algorithm": "ROUND_ROBIN",
+        "protocol": "HTTP",
+        "description": "",
+        "health_monitors": [
+            "b7633ade-24dc-4d72-8475-06aa22be5412"
+        ],
+        "members": [
+            "cf024846-7516-4e3a-b0fb-6590322c836f"
+        ],
+        "status_description": null,
+        "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+        "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
+        "name": "SuperPool",
+        "admin_state_up": true,
+        "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "health_monitors_status": [
+            {
+                "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
+                "status": "ACTIVE",
+                "status_description": null
+            }
+        ],
+        "provider": "haproxy"
+    }
+}
--- a/api-ref/source/samples/lbaas/pools-list-response.json
+++ b/api-ref/source/samples/lbaas/pools-list-response.json
@ -0,0 +1,31 @@
+{
+    "pools": [
+        {
+            "status": "ACTIVE",
+            "lb_algorithm": "ROUND_ROBIN",
+            "protocol": "HTTP",
+            "description": "",
+            "health_monitors": [
+                "b7633ade-24dc-4d72-8475-06aa22be5412"
+            ],
+            "members": [
+                "cf024846-7516-4e3a-b0fb-6590322c836f"
+            ],
+            "status_description": null,
+            "id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+            "vip_id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
+            "name": "pool1",
+            "admin_state_up": true,
+            "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
+            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+            "health_monitors_status": [
+                {
+                    "monitor_id": "b7633ade-24dc-4d72-8475-06aa22be5412",
+                    "status": "ACTIVE",
+                    "status_description": null
+                }
+            ],
+            "provider": "haproxy"
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/pools-list-response2.json
+++ b/api-ref/source/samples/lbaas/pools-list-response2.json
@ -0,0 +1,20 @@
+{
+    "pools": [
+        {
+            "admin_state_up": true,
+            "description": "simple pool",
+            "healthmonitor_id": null,
+            "id": "4c0a0a5f-cf8f-44b7-b912-957daa8ce5e5",
+            "lb_algorithm": "ROUND_ROBIN",
+            "listeners": [
+                {
+                    "id": "35cb8516-1173-4035-8dae-0dae3453f37f"
+                }
+            ],
+            "members": [],
+            "name": "pool1",
+            "protocol": "HTTP",
+            "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c"
+        }
+    ]
+}
--- a/api-ref/source/samples/lbaas/vip-create-request.json
+++ b/api-ref/source/samples/lbaas/vip-create-request.json
@ -0,0 +1,10 @@
+{
+    "vip": {
+        "protocol": "HTTP",
+        "name": "NewVip",
+        "admin_state_up": true,
+        "subnet_id": "0ba2ef27-0054-4b28-a8fa-f215e8079272",
+        "pool_id": "105320c3-8416-4997-9c1c-4098b95fdaca",
+        "protocol_port": "80"
+    }
+}
--- a/api-ref/source/samples/lbaas/vip-create-response.json
+++ b/api-ref/source/samples/lbaas/vip-create-response.json
@ -0,0 +1,19 @@
+{
+    "vip": {
+        "status": "PENDING_CREATE",
+        "protocol": "HTTP",
+        "description": "",
+        "address": "10.0.0.4",
+        "protocol_port": 80,
+        "port_id": "0ba4cd9c-edb4-4594-bac4-b68b49d5f04c",
+        "id": "fa0373e0-9dd4-4ff7-98fc-8cceca9bdb4e",
+        "status_description": null,
+        "name": "NewVip",
+        "admin_state_up": true,
+        "subnet_id": "0ba2ef27-0054-4b28-a8fa-f215e8079272",
+        "tenant_id": "e68c3e65e1f34ee9b2357d0fe418a78b",
+        "connection_limit": -1,
+        "pool_id": "105320c3-8416-4997-9c1c-4098b95fdaca",
+        "session_persistence": null
+    }
+}
--- a/api-ref/source/samples/lbaas/vip-show-response.json
+++ b/api-ref/source/samples/lbaas/vip-show-response.json
@ -0,0 +1,19 @@
+{
+    "vip": {
+        "status": "ACTIVE",
+        "protocol": "HTTP",
+        "description": "",
+        "address": "10.0.0.4",
+        "protocol_port": 80,
+        "port_id": "5328aeea-2988-41c0-b5fe-0fd0660979d3",
+        "id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
+        "status_description": null,
+        "name": "my-Vip",
+        "admin_state_up": true,
+        "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
+        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+        "connection_limit": -1,
+        "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+        "session_persistence": null
+    }
+}
--- a/api-ref/source/samples/lbaas/vip-update-request.json
+++ b/api-ref/source/samples/lbaas/vip-update-request.json
@ -0,0 +1,5 @@
+{
+    "vip": {
+        "connection_limit": "1000"
+    }
+}
--- a/api-ref/source/samples/lbaas/vip-update-response.json
+++ b/api-ref/source/samples/lbaas/vip-update-response.json
@ -0,0 +1,19 @@
+{
+    "vip": {
+        "status": "PENDING_UPDATE",
+        "protocol": "HTTP",
+        "description": "",
+        "address": "10.0.0.4",
+        "protocol_port": 80,
+        "port_id": "0ba4cd9c-edb4-4594-bac4-b68b49d5f04c",
+        "id": "fa0373e0-9dd4-4ff7-98fc-8cceca9bdb4e",
+        "status_description": null,
+        "name": "NewVip",
+        "admin_state_up": true,
+        "subnet_id": "0ba2ef27-0054-4b28-a8fa-f215e8079272",
+        "tenant_id": "e68c3e65e1f34ee9b2357d0fe418a78b",
+        "connection_limit": 1000,
+        "pool_id": "105320c3-8416-4997-9c1c-4098b95fdaca",
+        "session_persistence": null
+    }
+}
--- a/api-ref/source/samples/lbaas/vips-list-response.json
+++ b/api-ref/source/samples/lbaas/vips-list-response.json
@ -0,0 +1,21 @@
+{
+    "vips": [
+        {
+            "status": "ACTIVE",
+            "protocol": "HTTP",
+            "description": "",
+            "address": "10.0.0.4",
+            "protocol_port": 80,
+            "port_id": "5328aeea-2988-41c0-b5fe-0fd0660979d3",
+            "id": "388c739a-6a57-4e74-bc7b-a5cd60248bba",
+            "status_description": null,
+            "name": "my-Vip",
+            "admin_state_up": true,
+            "subnet_id": "aa547115-d710-4d6d-bb2c-b038d9c2704b",
+            "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",
+            "connection_limit": -1,
+            "pool_id": "5a9a3e9e-d1aa-448e-af37-a70171f2a332",
+            "session_persistence": null
+        }
+    ]
+}
--- a/api-ref/source/samples/metering-labels/metering-label-create-request.json
+++ b/api-ref/source/samples/metering-labels/metering-label-create-request.json
@ -0,0 +1,6 @@
+{
+    "metering_label": {
+        "name": "label1",
+        "description": "description of label1"
+    }
+}
--- a/api-ref/source/samples/metering-labels/metering-label-create-response.json
+++ b/api-ref/source/samples/metering-labels/metering-label-create-response.json
@ -0,0 +1,9 @@
+{
+    "metering_label": {
+        "tenant_id": "45345b0ee1ea477fac0f541b2cb79cd4",
+        "description": "description of label1",
+        "name": "label1",
+        "id": "bc91b832-8465-40a7-a5d8-ba87de442266",
+        "shared": false
+    }
+}
--- a/api-ref/source/samples/metering-labels/metering-label-delete-request-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-label-delete-request-json-http.txt
@ -0,0 +1,6 @@
+DELETE /v2.0/metering/metering-labels/a6700594-5b7a-4105-8bfe-723b346ce866 HTTP/1.1
+Host: controlnode:9696
+User-Agent: python-neutronclient
+Content-Type: application/json
+Accept: application/json
+X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
--- a/api-ref/source/samples/metering-labels/metering-label-delete-response-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-label-delete-response-json-http.txt
@ -0,0 +1 @@
+status: 204
--- a/api-ref/source/samples/metering-labels/metering-label-rule-create-request.json
+++ b/api-ref/source/samples/metering-labels/metering-label-rule-create-request.json
@ -0,0 +1,7 @@
+{
+    "metering_label_rule": {
+        "remote_ip_prefix": "10.0.1.0/24",
+        "direction": "ingress",
+        "metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812"
+    }
+}
--- a/api-ref/source/samples/metering-labels/metering-label-rule-create-response.json
+++ b/api-ref/source/samples/metering-labels/metering-label-rule-create-response.json
@ -0,0 +1,9 @@
+{
+    "metering_label_rule": {
+        "remote_ip_prefix": "10.0.1.0/24",
+        "direction": "ingress",
+        "metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812",
+        "id": "00e13b58-b4f2-4579-9c9c-7ac94615f9ae",
+        "excluded": false
+    }
+}
--- a/api-ref/source/samples/metering-labels/metering-label-rule-delete-request-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-label-rule-delete-request-json-http.txt
@ -0,0 +1,6 @@
+DELETE /v2.0/metering/metering-labels/37b31179-71ee-4f0a-b130-0eeb28e7ede7 HTTP/1.1
+Host: controlnode:9696
+User-Agent: python-neutronclient
+Content-Type: application/json
+Accept: application/json
+X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
--- a/api-ref/source/samples/metering-labels/metering-label-rule-delete-response-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-label-rule-delete-response-json-http.txt
@ -0,0 +1 @@
+status: 204
--- a/api-ref/source/samples/metering-labels/metering-label-rule-show-request-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-label-rule-show-request-json-http.txt
@ -0,0 +1,6 @@
+GET /v2.0/metering/metering-label-rules/9536641a-7d14-4dc5-afaf-93a973ce0eb8 HTTP/1.1
+Host: controlnode:9696
+User-Agent: python-neutronclient
+Content-Type: application/json
+Accept: application/json
+X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
--- a/api-ref/source/samples/metering-labels/metering-label-rule-show-response.json
+++ b/api-ref/source/samples/metering-labels/metering-label-rule-show-response.json
@ -0,0 +1,9 @@
+{
+    "metering_label_rule": {
+        "remote_ip_prefix": "20.0.0.0/24",
+        "direction": "ingress",
+        "metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812",
+        "id": "9536641a-7d14-4dc5-afaf-93a973ce0eb8",
+        "excluded": false
+    }
+}
--- a/api-ref/source/samples/metering-labels/metering-label-rules-list-request-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-label-rules-list-request-json-http.txt
@ -0,0 +1,6 @@
+GET /v2.0/metering/metering-label-rules HTTP/1.1
+Host: controlnode:9696
+User-Agent: python-neutronclient
+Content-Type: application/json
+Accept: application/json
+X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
--- a/api-ref/source/samples/metering-labels/metering-label-rules-list-response.json
+++ b/api-ref/source/samples/metering-labels/metering-label-rules-list-response.json
@ -0,0 +1,18 @@
+{
+    "metering_label_rules": [
+        {
+            "remote_ip_prefix": "20.0.0.0/24",
+            "direction": "ingress",
+            "metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812",
+            "id": "9536641a-7d14-4dc5-afaf-93a973ce0eb8",
+            "excluded": false
+        },
+        {
+            "remote_ip_prefix": "10.0.0.0/24",
+            "direction": "ingress",
+            "metering_label_id": "e131d186-b02d-4c0b-83d5-0c0725c4f812",
+            "id": "ffc6fd15-40de-4e7d-b617-34d3f7a93aec",
+            "excluded": false
+        }
+    ]
+}
--- a/api-ref/source/samples/metering-labels/metering-label-show-request-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-label-show-request-json-http.txt
@ -0,0 +1,6 @@
+GET /v2.0/metering/metering-labels/a6700594-5b7a-4105-8bfe-723b346ce866 HTTP/1.1
+Host: controlnode:9696
+User-Agent: python-neutronclient
+Content-Type: application/json
+Accept: application/json
+X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
--- a/api-ref/source/samples/metering-labels/metering-label-show-response.json
+++ b/api-ref/source/samples/metering-labels/metering-label-show-response.json
@ -0,0 +1,9 @@
+{
+    "metering_label": {
+        "tenant_id": "45345b0ee1ea477fac0f541b2cb79cd4",
+        "description": "label1 description",
+        "name": "label1",
+        "id": "a6700594-5b7a-4105-8bfe-723b346ce866",
+        "shared": false
+    }
+}
--- a/api-ref/source/samples/metering-labels/metering-labels-list-request-json-http.txt
+++ b/api-ref/source/samples/metering-labels/metering-labels-list-request-json-http.txt
@ -0,0 +1,6 @@
+GET /v2.0/metering/metering-labels HTTP/1.1
+Host: controlnode:9696
+User-Agent: python-neutronclient
+Content-Type: application/json
+Accept: application/json
+X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
--- a/Show More
+++ b/Show More