openstack/manila
Code Issues Proposed changes
1709fd7fc2
manila/api-ref/source/index.rst

47 lines
1.2 KiB
ReStructuredText
Raw Normal View History

Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
:tocdepth: 2
=======================
Shared File Systems API
=======================
.. rest_expand_all::
.. include:: versions.inc
.. include:: extensions.inc
.. include:: limits.inc
.. include:: shares.inc
.. include:: share-export-locations.inc
.. include:: share-metadata.inc
.. include:: share-actions.inc
.. include:: snapshots.inc
[doc] Add API document for snapshot instances This patch adds a new API document for snapshot instances. Change-Id: Ia0cc534e0bfb2ca5e495e575e27e9911c746690b
2017-08-07 16:55:05 +08:00
.. include:: snapshot-instances.inc
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
.. include:: share-networks.inc
.. include:: security-services.inc
.. include:: share-servers.inc
.. include:: share-instances.inc
.. include:: share-instance-export-locations.inc
.. include:: share-types.inc
.. include:: scheduler-stats.inc
.. include:: services.inc
.. include:: availability-zones.inc
.. include:: os-share-manage.inc
.. include:: quota-sets.inc
Add docs for quota_class_set API We have implemented quota-classes-show and quota-classes-update api, but no api-ref is documented. This patch is to add api-ref in the docs. Change-Id: I275ee4fe048607a49368c4f985c055ab3a3bbfb6 Closes-bug: #1751683
2018-02-26 10:00:46 +08:00
.. include:: quota-classes.inc
User Messages For quite some time, OpenStack services have wanted to be able to send messages to API end users (by user I do not mean the operator, but the user that is interacting with the client). This patch implements basic user messages with the following APIs. GET /messages GET /messages/<message_id> DELETE /messages/<message_id> Implements the basic /messages resource and tempest tests The patch is aligned with related cinder patch where possible: I8a635a07ed6ff93ccb71df8c404c927d1ecef005 DocImpact APIImpact Needed-By: I5ffb840a271c518f62ee1accfd8e20a97f45594d Needed-By: I9ce096eebda3249687268e361b7141dea4032b57 Needed-By: Ic7d25a144905a39c56ababe8bd666b01bc0d0aef Partially-implements: blueprint user-messages Co-Authored-By: Jan Provaznik <jprovazn@redhat.com> Change-Id: Ia0cc524e0bfb2ca5e495e575e17e9911c746690b
2016-05-06 09:33:09 -04:00
.. include:: user-messages.inc
Add api ref for access rule metadata feature Partially-implements: bp metadata-for-access-rule Change-Id: Icbac8ec427e23f6a781a7d3e682fe4852fa16179
2018-07-17 11:06:05 +08:00
.. include:: share-access-rules.inc
.. include:: share-access-rule-metadata.inc
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
======================================
Shared File Systems API (EXPERIMENTAL)
======================================
.. rest_expand_all::
[doc] Move Experimental APIs description to a common place Change-Id: I41695632d48f7cbcbe008867671f8196b5543c93
2017-08-17 16:36:19 +08:00
.. include:: experimental.inc
Migrate API reference into tree The API Documentation team has requires [1] that projects maintain their api-reference in-tree and build it to the developer.openstack.org website. This version of the API reference uses os-api-ref and compiles API documentation close to that of the OpenStack compute service (nova). Co-Authored-By: Goutham Pacha Ravi <gouthamr@netapp.com> [0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html Implements: bp move-manila-api-reference-in-tree Change-Id: I67bb3354162d6e0e00fa2788edde864cc14920ee
2016-05-07 17:18:15 +02:00
.. include:: share-migration.inc
Add API document for share replica This patch adds a new API document for share replica. Change-Id: Ia0cc534e0bfb2ca4e485e575e27e9911c746691b
2017-08-16 17:25:22 +08:00
.. include:: share-replicas.inc
Separate APIs for share & replica export locations Users of replicated shares expect to see primary export locations when viewing information regarding the share. Because we collate exports of all replicas within the export locations APIs, it becomes hard for users to discern which exports belong to the primary share. For secondary replicas, users would also need additional information (availability zone, state of the replication) to work with. Introduce micro-version 2.47 from which the export locations API (GET /v2/{tenant_id}/shares/{share_id}/export_locations) no longer provides export locations of non-active share replicas. A new API has been introduced to provide export location details for share replicas, both active and non-active. (GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations) The new API provides the replica's state and availability zone in addition to the export location information. APIImpact Implements: bp export-locations-az Change-Id: I0a1d9dd00b4c13ac01988e30ca2b7d7ce4a747d1
2018-12-27 01:01:08 -08:00
.. include:: share-replica-export-locations.inc
Add API document for share group [2/3] This patch adds a new API document for share group Partial-Bug: 1724716 Change-Id: I852d264eb120027aad32997dc64a6ca128ee55a3
2017-10-31 19:57:42 +08:00
.. include:: share-groups.inc
Add API document for share group [1/3] This patch adds a new API document for share group type. Partial-Bug: 1724716 Change-Id: I852d264eb120027aad32997dc64a6ca428ee55a4
2017-08-04 10:47:27 +08:00
.. include:: share-group-types.inc
Add API document for share group [3/3] This patch adds a new API document for share group snapshot. Partial-Bug: 1724716 Change-Id: I832d264eb220027aad32937dc64a6ca428ee55a4
2017-10-31 20:36:03 +08:00
.. include:: share-group-snapshots.inc
Copy Permalink