openstack/octavia
Code Issues Proposed changes
cc18c1e1b5
octavia/api-ref/source/v2/index.rst

83 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Adds v2 general API information section This patch add the general information section to the v2 API reference. Change-Id: I7b780d4afaa19801d800ab24f5c6ab922b57a7e2 Partial-Bug: #1558385
2017-02-13 15:28:29 -08:00
:tocdepth: 3
Create api-ref base for Octavia This patch will create the initial directory and index for the api reference documentation (using the new guidelines) for the Octavia API. Change-Id: Id5fbe569acfe7348f4f9dfc9cbef49834ea824c3 Partial-Bug: #1558385
2017-02-10 14:04:20 -08:00
Fix version discovery for the Octavia API This adds the required "links" part of the version discovery document. Change-Id: I18e75116e1da47991d68b0842892f1036adec41a Story: 2001796 Task: 12518
2018-04-06 19:55:01 -07:00
========================
Octavia API v2 (Current)
========================
Create api-ref base for Octavia This patch will create the initial directory and index for the api reference documentation (using the new guidelines) for the Octavia API. Change-Id: Id5fbe569acfe7348f4f9dfc9cbef49834ea824c3 Partial-Bug: #1558385
2017-02-10 14:04:20 -08:00
.. rest_expand_all::
--------------------
General API Overview
--------------------
Adds v2 general API information section This patch add the general information section to the v2 API reference. Change-Id: I7b780d4afaa19801d800ab24f5c6ab922b57a7e2 Partial-Bug: #1558385
2017-02-13 15:28:29 -08:00
.. include:: general.inc
Create api-ref base for Octavia This patch will create the initial directory and index for the api reference documentation (using the new guidelines) for the Octavia API. Change-Id: Id5fbe569acfe7348f4f9dfc9cbef49834ea824c3 Partial-Bug: #1558385
2017-02-10 14:04:20 -08:00
Adds v2 general API information section This patch add the general information section to the v2 API reference. Change-Id: I7b780d4afaa19801d800ab24f5c6ab922b57a7e2 Partial-Bug: #1558385
2017-02-13 15:28:29 -08:00
--------------
Create api-ref base for Octavia This patch will create the initial directory and index for the api reference documentation (using the new guidelines) for the Octavia API. Change-Id: Id5fbe569acfe7348f4f9dfc9cbef49834ea824c3 Partial-Bug: #1558385
2017-02-10 14:04:20 -08:00
Load Balancers
Adds v2 general API information section This patch add the general information section to the v2 API reference. Change-Id: I7b780d4afaa19801d800ab24f5c6ab922b57a7e2 Partial-Bug: #1558385
2017-02-13 15:28:29 -08:00
--------------
Adds v2 load balancer API section This patch adds the load balancer section to the v2 API reference. Change-Id: Ibe5b6372ba859f47e6738e97ff14c66f58514e42 Partial-Bug: #1558385
2017-02-13 15:28:29 -08:00
.. include:: loadbalancer.inc
Add v2 listener API section This patch adds the listener section to the v2 API reference. Change-Id: I09731856fedb3758f850208028974dfda080d08a Partial-Bug: #1558385
2017-04-11 08:38:19 -07:00
---------
Listeners
---------
.. include:: listener.inc
Add v2 pool API section This patch adds the pool section to the v2 API reference. Change-Id: I70e5cb07a4435f58f5da3999be70162efa7f0bd8 Partial-Bug: #1558385
2017-04-19 11:53:27 -07:00
-----
Pools
-----
.. include:: pool.inc
Add v2 member API section This patch adds the member section to the v2 API reference. Change-Id: I5e10a215d685c27a7e5be882a2598fe7cb3875ee Partial-Bug: #1558385
2017-05-11 10:42:17 -07:00
-------
Members
-------
.. include:: member.inc
Add v2 health monitor API section This patch adds the health monitor section to the v2 API reference. Change-Id: I269eb6e457d317e7d942adcc1d957bc96e4a315f Partial-Bug: #1558385
2017-05-11 17:02:57 -07:00
--------------
Health Monitor
--------------
.. include:: healthmonitor.inc
Add v2 L7 Policy API section This patch adds the L7 policy section to the v2 API reference. This patch also updates the child object create error code lists to include 409 as a possible error code. Change-Id: I6cb469c65832af3440c18dc71c7786a8fbf9bd2b Partial-Bug: #1558385
2017-06-24 16:35:21 -07:00
-----------
L7 Policies
-----------
.. include:: l7policy.inc
Add v2 L7 Rule API section This patch adds the L7 rule section to the v2 API reference. Change-Id: I43ad86c7cc72b4844247c39f76f30dde349e7a65 Partial-Bug: #1558385
2017-06-27 10:00:42 -07:00
--------
L7 Rules
--------
.. include:: l7rule.inc
Add v2 Quota API section This patch adds the quota section to the v2 API reference. Change-Id: I23cd2c4a65e4d7bf3c85f176a3042fefe0fb35b9 Partial-Bug: #1558385
2017-06-27 17:39:01 -07:00
------
Quotas
------
.. include:: quota.inc
Add admin endpoint for amphora info Administrators can now use /v2.0/octavia/amphorae to retrieve internal information about amphora details like compute_id and lb_network_ip. Change-Id: I5ac8d1ce189db09d52e518d42aeb3a192b8a8814
2017-09-19 13:42:52 -07:00
Implement provider drivers - Cleanup This patch addresses the following: Fixes some unit tests. Cleans up some code from the parent patches, Adds a release note for the provider driver support. Adds the "List providers" API. Adds a document listing the know provider drivers. Adds a provider driver development guide. Change-Id: I90dc39e5e9d7d5839913dc2dbf187d935ee2b8b5 Story: 1655768 Task: 5165
2018-05-09 11:47:04 -07:00
---------
Providers
---------
.. include:: provider.inc
Add flavors/flavor_profile api-ref This patch adds the api-ref updates for the new flavors and flavor profile API. Change-Id: I11ab9af188731a1eaf1f402c4d55a944dc85ea88
2018-11-15 14:40:20 -08:00
-------
Flavors
-------
.. include:: flavor.inc
---------------
Flavor Profiles
---------------
.. include:: flavorprofile.inc
Availability Zone admin API Adds the ability for admins to create/manage availability_zones and profiles for use with upcoming functionality. Works like flavors. Depends-On: https://review.opendev.org/#/c/694057/ Change-Id: I468d9fdf8c9d0898f9e30f04ac233510a10a53fc
2019-11-12 18:15:38 -08:00
------------------
Availability Zones
------------------
.. include:: availabilityzone.inc
--------------------------
Availability Zone Profiles
--------------------------
.. include:: availabilityzoneprofile.inc
Add admin endpoint for amphora info Administrators can now use /v2.0/octavia/amphorae to retrieve internal information about amphora details like compute_id and lb_network_ip. Change-Id: I5ac8d1ce189db09d52e518d42aeb3a192b8a8814
2017-09-19 13:42:52 -07:00
--------
Amphorae
--------
.. include:: amphora.inc
Copy Permalink