Clarify volume UUID semantics for /storage/volumes/{uuid}

[Salmanius]

Page URL

https://docs.netapp.com/us-en/ontap-restapi/get-storage-volumes-.html

Page title

Retrieve a volume

Summary

Problem

A customer reported confusion around the volume REST docs because the page path uses {uuid}, but the value that works for /api/storage/volumes/{uuid} is the volume instance-uuid from CLI/ONTAPI, not the CLI uuid field. This led to 404s when the wrong identifier was used.

Affected webpage(s)

These are the published pages that need the clarification:

• https://docs.netapp.com/us-en/ontap-restapi/get-storage-volumes-.html
• https://docs.netapp.com/us-en/ontap-restapi/get-storage-volumes.html
• https://docs.netapp.com/us-en/ontap-restapi/storage_volumes_endpoint_overview.html

Source files to update

These pages are generated from the following source .adoc files in the repo, so the wording change should be made there:

• get-storage-volumes-.adoc
• get-storage-volumes.adoc
• storage_volumes_endpoint_overview.adoc

Requested documentation changes

1. In get-storage-volumes-.adoc, clarify the {uuid} path parameter means the volume instance-uuid from CLI/ONTAPI.
2. In get-storage-volumes-.adoc, clarify the returned uuid field is the identifier used in /storage/volumes/{uuid} and corresponds to CLI/ONTAPI instance-uuid.
3. In get-storage-volumes.adoc, change the query filter description from Filter by uuid to Filter by volume instance-uuid (CLI/ONTAPI).
4. In storage_volumes_endpoint_overview.adoc, add a short note that the {uuid} in the endpoint refers to the volume instance-uuid.

Requested documentation wording changes

1. get-storage-volumes-.adoc

   • Path parameter uuid:
     • Unique identifier of the volume.
     • change to: Unique identifier of the volume. This is the volume instance-uuid exposed in the CLI and ONTAPI.

2. get-storage-volumes.adoc

   • Query filter uuid:
     • Filter by uuid
     • change to: Filter by volume instance-uuid (CLI/ONTAPI)

3. get-storage-volumes.adoc

   • Volume field uuid:
     • Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
     • change to: Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move. Use this value for /storage/volumes/{uuid} lookups.

4. storage_volumes_endpoint_overview.adoc

   • Add a note near the Volume APIs list:
     • For /api/storage/volumes/{uuid}, uuid means the volume instance-uuid exposed in the CLI and ONTAPI.

Why this matters

The current wording is easy to misread because the docs use {uuid} in the path while CLI output also shows a separate uuid field. The mismatch makes it easy to call the endpoint with the wrong identifier and get a 404.

Public issues must not contain sensitive information

• This issue contains no sensitive information.

[netapp-aoife]

Hi @Salmanius, thanks for raising this issue. We'll verify and update accordingly.