Fix docs for the annotation download file format (#6546)

scalableminds · Oct 12, 2022 · faa9f1f · faa9f1f
1 parent 94715b5
commit faa9f1f
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/docs/rest_api.md b/docs/rest_api.md
@@ -344,13 +344,17 @@ Download an annotation as NML/ZIP
 
 #### Returns
  - As chunked file stream:
-   - In case of a volume annotation:
-     - A ZIP file containing both an NML file and a data.zip file with the volume data
-   - In case of a single explorative or task annotation with no volume annotation:
+   - In case of a single skeleton-only annotation:
      - A single NML file
+   - In case of a single annotation with volume layers
+     - A ZIP file containing both an NML file and data zip files with the volume data for each volume layer. The data zip file names are referenced in the `<volume>` tags in the NML file.
    - In case of compound downloads (CompoundTask/CompoundProject/CompoundTaskType):
      - A ZIP file containing individual NML files for all associated annotations
 
+
+#### Note
+ - The volume data zip file name used to always be `data.zip`, when wk supported only a single volume layer per annotation. Please use the file names referenced in the `<volume>` tags in the NML file instead.
+
 ---
 ### `POST /annotations/upload`