[DOC] Missing API reference for /shares/{share_id}/instances

[Goutham Pacha Ravi]

- [x] This is a doc addition request.

The manila v2 API exposes a /shares/{share_id}/instances endpoint that accepts GET requests; however, this information is missing from the API reference.

Sample request/response:

curl -i -X GET http://sfs.org/share/v2/shares/2478f109-2023-46be-91de-fc967fe5bd7e/instances -H "X-Auth-Token: $TOKEN" -H "X-Openstack-Manila-Api-Version: 2.65" -H "Accept: application/json"

RESP: [200] {'Date': 'Tue, 30 Nov 2021 00:04:45 GMT', 'Server': 'Apache/2.4.41 (Ubuntu)', 'Content-Type': 'application/json', 'Content-Length': '490', 'x-compute-request-id': 'req-45f3f17a-8722-4d9e-b585-5748da08b48b', 'X-OpenStack-Manila-API-Version': '2.65', 'Vary': 'X-OpenStack-Manila-API-Version', 'Connection': 'close'}
RESP BODY: {"share_instances": [{"id": "0564aed9-8cf7-405e-986b-eed334a0c12e", "share_id": "2478f109-2023-46be-91de-fc967fe5bd7e", "availability_zone": "nova", "created_at": "2021-09-03T07:49:30.219215", "host": "zorilla-cephfs@delta#fake_pool_for_DELTA", "status": "available", "share_network_id": null, "share_server_id": null, "access_rules_status": "active", "replica_state": "active", "share_type_id": "78dee8a9-1ee6-4a29-9081-14e6596fbb96", "cast_rules_to_readonly": false, "progress": "100%"}]}

-----------------------------------
Release: on 2020-04-15 18:58:19
SHA: 6fdd3838ba3db9570fc7a873477b798d632ef531
Source: https://opendev.org/openstack/manila/src/api-ref/source/index.rst
URL: https://docs.openstack.org/api-ref/shared-file-system/?expanded=list-share-instances-detail

[Vida Haririan (vhariria)]

Additional comments at https://meetings.opendev.org/meetings/manila/2021/manila.2021-12-09-15.00.log.html

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/manila/+/824060

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/manila/+/824060
Committed: https://opendev.org/openstack/manila/commit/603e484fb6128dface4945ebacbe8d0edb4f408e
Submitter: "Zuul (22348)"
Branch: master

commit 603e484fb6128dface4945ebacbe8d0edb4f408e
Author: Fabio Oliveira <email address hidden>
Date: Mon Jan 10 15:48:54 2022 -0300

    api-ref: Add share instances by share endpoint

    The endpoint for /shares/{share_id}/instances was missing for the
    share section.
    This patch adds the section and update the existing one on
    v2/shate_instances.

    Closes-Bug: 1952673
    Change-Id: Ie8412379c20528575d2e67485ce955bcf8c13eee

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/manila 14.0.0.0rc1 release candidate.